Document
StoryChildNodes
Represents a child nodes of Story or InlineStory.
This class is used in Comment, Footnote, OfficeMathObject.
A single ChildNodes property is defined:
| Property | Type | Description |
|---|---|---|
| ChildNodes | List<NodeLink> | Gets or sets the list of child nodes. |
CompareOptions
Represents a dTO container with compare documents options.
This class is used in CompareData.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| AcceptAllRevisionsBeforeComparison | bool | Gets or sets whether accept revisions before comparison or not. |
| IgnoreCaseChanges | bool | Gets or sets a value indicating whether documents comparison is case insensitive. By default comparison is case sensitive. |
| IgnoreComments | bool | Gets or sets a value indicating whether comments content is ignored. By default comments are not ignored. |
| IgnoreFields | bool | Gets or sets a value indicating whether fields content is ignored. By default fields are not ignored. |
| IgnoreFootnotes | bool | Gets or sets a value indicating whether footnotes/endnotes content is ignored. By default footnotes/endnotes are not ignored. |
| IgnoreFormatting | bool | Gets or sets a value indicating whether formatting is ignored. By default document formatting is not ignored. |
| IgnoreHeadersAndFooters | bool | Gets or sets a value indicating whether headers and footers content is ignored. By default headers and footers are not ignored. |
| IgnoreTables | bool | Gets or sets a value indicating whether tables content is ignored. By default tables are not ignored. |
| IgnoreTextboxes | bool | Gets or sets a value indicating whether textboxes content is ignored. By default textboxes are not ignored. |
| Target | TargetEnum | Gets or sets the option that controls which document shall be used as a target during comparison. |
Document
Represents a Words document DTO.
This class is used in DocumentResponse.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| DocumentProperties | DocumentProperties | Gets or sets the document properties. |
| FileName | string | Gets or sets the name of the file. |
| IsEncrypted | bool | Gets or sets a value indicating whether the document is encrypted and requires a password to open. |
| IsSigned | bool | Gets or sets a value indicating whether the document contains a digital signature. This property merely informs that a digital signature is present on a document, but it does not specify whether the signature is valid or not. |
| Links | List<Link> | Gets or sets the list of links that originate from this document. |
| SourceFormat | SourceFormatEnum | Gets or sets the original format of the document. |
DocumentEntry
Represents a document which will be appended to the original resource document.
This class is used in DocumentEntryList.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| EncryptedPassword | string | Gets or sets document password encrypted on API public key. The default value is null (the document has no password) . |
| Href | string | Gets or sets the path to document to append at the server. |
| ImportFormatMode | string | Gets or sets the option that controls formatting will be used: appended or destination document. Can be KeepSourceFormatting or UseDestinationStyles. |
DocumentEntryList
Represents a list of documents which will be appended to the original resource document.
This class is used in AppendDocumentOnlineRequest, AppendDocumentRequest.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| ApplyBaseDocumentHeadersAndFootersToAppendingDocuments | bool | Gets or sets a value indicating whether to apply headers and footers from base document to appending documents. The default value is true. |
| DocumentEntries | List<DocumentEntry> | Gets or sets the list of documents. |
DocumentPosition
Represents a dTO container with a position in the document tree.
This class is used in Comment, CommentBase, CommentInsert, CommentUpdate, DrawingObjectInsert, Footnote, FootnoteBase, SearchResult, TableInsert, TableInsertDto.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| Node | NodeLink | Gets or sets the link to a node. |
| Offset | int | Gets or sets the offset in the node. |
Link
Represents a provides information for the object link. This is supposed to be an atom:link, therefore it should have all attributes specified here http://tools.ietf.org/html/rfc4287#section-4.2.7.
This class is used in Document.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| Href | string | Gets or sets the “href” attribute with the link’s IRI. atom:link elements MUST have an href attribute, whose value MUST be a IRI reference. |
| Rel | string | Gets or sets the option that controls whether atom:link elements MAY have a “rel” attribute that indicates the link relation type. If the “rel” attribute is not present, the link element MUST be interpreted as if the link relation type is “alternate”. |
| Title | string | Gets or sets the “title” attribute, that conveys human-readable information about the link. The content of the “title” attribute is Language-Sensitive. |
| Type | string | Gets or sets the “type” attribute. The “type” attribute’s value is an advisory media type: it is a hint about the type of the representation that is expected to be returned when the value of the href attribute is dereferenced. Note that the type attribute does not override the actual media type returned with the representation. |
OptimizationOptions
Represents a container class for the document optimization options.
This class is used in OptimizeDocumentOnlineRequest, OptimizeDocumentRequest.
A single MsWordVersion property is defined:
| Property | Type | Description |
|---|---|---|
| MsWordVersion | MsWordVersionEnum | Gets or sets the specific MSWord version. |
RangeDocument
Represents a dTO container with a Range element.
This class is used in SaveAsRangeOnlineRequest, SaveAsRangeRequest.
A single DocumentName property is defined:
| Property | Type | Description |
|---|---|---|
| DocumentName | string | Gets or sets the name for a new document. |
SaveResult
Represents a result of saving.
This class is used in SaveResponse.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| AdditionalItems | List<FileLink> | Gets or sets the list of links to additional items (css, images etc) . |
| DestDocument | FileLink | Gets or sets the link to destination document. |
| SourceDocument | FileLink | Gets or sets the link to source document. |
SplitDocumentResult
Represents a result of splitting document.
This class is used in SplitDocumentResponse.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| Pages | List<FileLink> | Gets or sets the list of pages. |
| SourceDocument | FileLink | Gets or sets the link to the source document. |
| ZippedPages | FileLink | Gets or sets the link to the file archive with pages. |
CompareData
Represents a container class for compare documents.
This class is used in CompareDocumentOnlineRequest, CompareDocumentRequest.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| Author | string | Gets or sets the initials of the author to use for revisions. |
| CompareOptions | CompareOptions | Gets or sets the compare options. |
| ComparingWithDocument | string | Gets or sets the path to document to compare at the server. |
| DateTime | DateTime | Gets or sets the date and time to use for revisions. |
| ResultDocumentFormat | string | Gets or sets the result document format. |
LoadWebDocumentData
Represents a contains data for load web document.
This class is used in LoadWebDocumentRequest.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| LoadingDocumentUrl | string | Gets or sets the web document URL. |
| SaveOptions | SaveOptionsData | Gets or sets the save options. |
SaveOptionsData
Represents a base container class for save options data.
This class is used in LoadWebDocumentData, SaveAsOnlineRequest, SaveAsRequest.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| AllowEmbeddingPostScriptFonts | bool | Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false.. |
| CustomTimeZoneInfoData | TimeZoneInfoData | Gets or sets CustomTimeZoneInfo. |
| Dml3DEffectsRenderingMode | Dml3DEffectsRenderingModeEnum | Gets or sets the value determining how 3D effects are rendered. |
| DmlEffectsRenderingMode | DmlEffectsRenderingModeEnum | Gets or sets the value determining how DrawingML effects are rendered. { Simplified |
| DmlRenderingMode | DmlRenderingModeEnum | Gets or sets the option that controls how DrawingML shapes are rendered. |
| FileName | string | Gets or sets the name of destination file. |
| FlatOpcXmlMappingOnly | bool | Gets or sets value determining which document formats are allowed to be mapped by Aspose.Words.Markup.StructuredDocumentTag.XmlMapping. By default only Aspose.Words.LoadFormat.FlatOpc document format is allowed to be mapped. |
| ImlRenderingMode | ImlRenderingModeEnum | Gets or sets the value determining how ink (InkML) objects are rendered. |
| SaveFormat | string | Gets the format of save. |
| UpdateCreatedTimeProperty | bool | Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving. Default value is false. |
| UpdateFields | bool | Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true. |
| UpdateLastPrintedProperty | bool | Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted property is updated before saving. |
| UpdateLastSavedTimeProperty | bool | Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving. |
| UpdateSdtContent | bool | Gets or sets a value indicating whether content of StructuredDocumentTag is updated before saving. |
| ZipOutput | bool | Gets or sets a value indicating whether to zip output or not. The default value is false. |
TiffSaveOptionsData
Represents a container class for tiff save options.
This class is inherited from ImageSaveOptionsData and used in SaveAsTiffOnlineRequest, SaveAsTiffRequest.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| AllowEmbeddingPostScriptFonts | bool | Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is false.. |
| CustomTimeZoneInfoData | TimeZoneInfoData | Gets or sets CustomTimeZoneInfo. |
| Dml3DEffectsRenderingMode | Dml3DEffectsRenderingModeEnum | Gets or sets the value determining how 3D effects are rendered. |
| DmlEffectsRenderingMode | DmlEffectsRenderingModeEnum | Gets or sets the value determining how DrawingML effects are rendered. { Simplified |
| DmlRenderingMode | DmlRenderingModeEnum | Gets or sets the option that controls how DrawingML shapes are rendered. |
| FileName | string | Gets or sets the name of destination file. |
| FlatOpcXmlMappingOnly | bool | Gets or sets value determining which document formats are allowed to be mapped by Aspose.Words.Markup.StructuredDocumentTag.XmlMapping. By default only Aspose.Words.LoadFormat.FlatOpc document format is allowed to be mapped. |
| ImlRenderingMode | ImlRenderingModeEnum | Gets or sets the value determining how ink (InkML) objects are rendered. |
| SaveFormat | string | Gets the format of save. |
| UpdateCreatedTimeProperty | bool | Gets or sets a value determining whether the Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime property is updated before saving. Default value is false. |
| UpdateFields | bool | Gets or sets a value indicating whether fields should be updated before saving the document to a fixed page format. The default value is true. |
| UpdateLastPrintedProperty | bool | Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted property is updated before saving. |
| UpdateLastSavedTimeProperty | bool | Gets or sets a value indicating whether the Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime property is updated before saving. |
| UpdateSdtContent | bool | Gets or sets a value indicating whether content of StructuredDocumentTag is updated before saving. |
| ZipOutput | bool | Gets or sets a value indicating whether to zip output or not. The default value is false. |
| ColorMode | ColorModeEnum | Gets or sets the value determining how colors are rendered. { Normal |
| JpegQuality | int | Gets or sets the quality of the JPEG images inside PDF document. |
| MetafileRenderingOptions | MetafileRenderingOptionsData | Gets or sets the metafile rendering options. |
| NumeralFormat | NumeralFormatEnum | Gets or sets the symbol set, that is used to represent numbers while rendering to fixed page formats. |
| OptimizeOutput | bool | Gets or sets a value indicating whether it is required to optimize output of XPS. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true.. The default value is false. |
| PageCount | int | Gets or sets the number of pages to render. |
| PageIndex | int | Gets or sets the 0-based index of the first page to render. |
| HorizontalResolution | double | Gets or sets the horizontal resolution in dots per inch for the generated images. This property has effect only when saving to raster image formats. The default value is 96. |
| ImageBrightness | double | Gets or sets the brightness level of the image. |
| ImageColorMode | ImageColorModeEnum | Gets or sets the color mode of the image. |
| ImageContrast | double | Gets or sets the contrast level of the image. |
| PaperColor | string | Gets or sets the background (paper) color of the image. |
| PixelFormat | PixelFormatEnum | Gets or sets the pixel format of the image. |
| Resolution | double | Gets or sets both horizontal and vertical resolution in dots per inch for the generated images. This property has effect only when saving to raster image formats. The default value is 96. |
| Scale | double | Gets or sets the zoom factor of the image. |
| UseAntiAliasing | bool | Gets or sets a value indicating whether to use anti-aliasing for rendering. |
| UseGdiEmfRenderer | bool | Gets or sets a value indicating whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF. |
| UseHighQualityRendering | bool | Gets or sets a value indicating whether to use high quality (i.e. slow) rendering algorithms. |
| VerticalResolution | double | Gets or sets the vertical resolution in dots per inch for the generated images. This property has effect only when saving to raster image formats. The default value is 96. |
| ThresholdForFloydSteinbergDithering | int | Gets or sets the threshold that determines the value of the binarization error in the Floyd-Steinberg method. when ImageBinarizationMethod is ImageBinarizationMethod.FloydSteinbergDithering. Default value is 128. |
| TiffBinarizationMethod | TiffBinarizationMethodEnum | Gets or sets the method used while converting images to 1 bpp format. |
| TiffCompression | TiffCompressionEnum | Gets or sets the type of compression. |
TimeZoneInfoData
Represents a class to specify TimeZoneInfo parameters.
This class is used in BmpSaveOptionsData, DocmSaveOptionsData, DocSaveOptionsData, DocxSaveOptionsData, DotmSaveOptionsData, DotSaveOptionsData, DotxSaveOptionsData, EmfSaveOptionsData, EpubSaveOptionsData, FixedPageSaveOptionsData, FlatOpcMacroSaveOptionsData, FlatOpcSaveOptionsData, FlatOpcTemplateMacroSaveOptionsData, FlatOpcTemplateSaveOptionsData, GifSaveOptionsData, HtmlFixedSaveOptionsData, HtmlSaveOptionsData, ImageSaveOptionsData, JpegSaveOptionsData, MhtmlSaveOptionsData, OdtSaveOptionsData, OoxmlSaveOptionsData, OttSaveOptionsData, PclSaveOptionsData, PdfSaveOptionsData, PngSaveOptionsData, PsSaveOptionsData, RtfSaveOptionsData, SaveOptionsData, SvgSaveOptionsData, TiffSaveOptionsData, TxtSaveOptionsBaseData, WordMLSaveOptionsData, XamlFixedSaveOptionsData, XamlFlowSaveOptionsData, XpsSaveOptionsData.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| BaseUtcOffset | string | Gets or sets base utc offset in hh:mm:ss format. |
| DisplayName | string | Gets or sets display name. |
| Id | string | Gets or sets an Id string for CustomTimeZoneInfo. |
| StandardDisplayName | string | Gets or sets standard display name. |
DocumentResponse
Represents a REST response with a document description.
This class is inherited from WordsResponse and used in WordsApi, AppendDocumentOnlineResponse, CompareDocumentOnlineResponse, DeleteWatermarkOnlineResponse, InsertPageNumbersOnlineResponse, InsertWatermarkImageOnlineResponse, InsertWatermarkTextOnlineResponse, RemoveRangeOnlineResponse, ReplaceWithTextOnlineResponse, SaveAsRangeOnlineResponse, UpdateFieldsOnlineResponse.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| RequestId | string | Gets or sets the request Id. |
| Document | Document | Gets or sets the document description. |
AppendDocumentOnlineRequest
Represents a request model for WordsApi.AppendDocumentOnline() operation.
An object of the AppendDocumentOnlineRequest class is created by the following constructor methods:
- AppendDocumentOnlineRequest()
- AppendDocumentOnlineRequest(Stream document, DocumentEntryList documentList, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| document | Document | Stream | Original document. |
| documentList | DocumentList | DocumentEntryList | |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| destFileName | DestFileName | string | Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. |
| revisionAuthor | RevisionAuthor | string | Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. |
| revisionDateTime | RevisionDateTime | string | The date and time to use for revisions. |
AppendDocumentOnlineResponse
Represents a response model for WordsApi.AppendDocumentOnline() operation.
An object of the AppendDocumentOnlineResponse class is created by the following constructor methods:
- AppendDocumentOnlineResponse(DocumentResponse model, Dictionary<string,Stream> document)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| model | Model | DocumentResponse | The response model. |
| document | Document | Dictionary<string,Stream> | The document after modification. |
AppendDocumentRequest
Represents a request model for WordsApi.AppendDocument() operation.
An object of the AppendDocumentRequest class is created by the following constructor methods:
- AppendDocumentRequest()
- AppendDocumentRequest(string name, DocumentEntryList documentList, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| name | Name | string | The filename of the input document. |
| documentList | DocumentList | DocumentEntryList | |
| folder | Folder | string | Original document folder. |
| storage | Storage | string | Original document storage. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| destFileName | DestFileName | string | Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. |
| revisionAuthor | RevisionAuthor | string | Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. |
| revisionDateTime | RevisionDateTime | string | The date and time to use for revisions. |
CompareDocumentOnlineRequest
Represents a request model for WordsApi.CompareDocumentOnline() operation.
An object of the CompareDocumentOnlineRequest class is created by the following constructor methods:
- CompareDocumentOnlineRequest()
- CompareDocumentOnlineRequest(Stream document, CompareData compareData, Stream comparingDocument, string loadEncoding, string password, string encryptedPassword, string destFileName, string encryptedPassword2)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| document | Document | Stream | The document. |
| compareData | CompareData | CompareData | Compare data. |
| comparingDocument | ComparingDocument | Stream | The comparing document. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| destFileName | DestFileName | string | Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. |
| encryptedPassword2 | EncryptedPassword2 | string | encrypted password for the second document. |
CompareDocumentOnlineResponse
Represents a response model for WordsApi.CompareDocumentOnline() operation.
An object of the CompareDocumentOnlineResponse class is created by the following constructor methods:
- CompareDocumentOnlineResponse(DocumentResponse model, Dictionary<string,Stream> document)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| model | Model | DocumentResponse | The response model. |
| document | Document | Dictionary<string,Stream> | The document after modification. |
CompareDocumentRequest
Represents a request model for WordsApi.CompareDocument() operation.
An object of the CompareDocumentRequest class is created by the following constructor methods:
- CompareDocumentRequest()
- CompareDocumentRequest(string name, CompareData compareData, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string encryptedPassword2)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| name | Name | string | The filename of the input document. |
| compareData | CompareData | CompareData | Compare data. |
| folder | Folder | string | Original document folder. |
| storage | Storage | string | Original document storage. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| destFileName | DestFileName | string | Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. |
| encryptedPassword2 | EncryptedPassword2 | string | encrypted password for the second document. |
ConvertDocumentRequest
Represents a request model for WordsApi.ConvertDocument() operation.
An object of the ConvertDocumentRequest class is created by the following constructor methods:
- ConvertDocumentRequest()
- ConvertDocumentRequest(Stream document, string format, string outPath, string fileNameFieldValue, string storage, string fontsLocation)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| document | Document | Stream | Converting document. |
| format | Format | string | The format to convert. |
| outPath | OutPath | string | The path to the output document on a local storage. |
| fileNameFieldValue | FileNameFieldValue | string | The filename of the output document, that will be used when the resulting document has a dynamic field {filename}. If it is not set, the “sourceFilename” will be used instead. |
| storage | Storage | string | Original document storage. |
| fontsLocation | FontsLocation | string | Folder in filestorage with custom fonts. |
CreateDocumentRequest
Represents a request model for WordsApi.CreateDocument() operation.
An object of the CreateDocumentRequest class is created by the following constructor methods:
- CreateDocumentRequest()
- CreateDocumentRequest(string fileName, string folder, string storage)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| fileName | FileName | string | The filename of the document. |
| folder | Folder | string | The path to the document folder. |
| storage | Storage | string | Original document storage. |
GetDocumentRequest
Represents a request model for WordsApi.GetDocument() operation.
An object of the GetDocumentRequest class is created by the following constructor methods:
- GetDocumentRequest()
- GetDocumentRequest(string documentName, string folder, string storage, string loadEncoding, string password, string encryptedPassword)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| documentName | DocumentName | string | The filename of the input document. |
| folder | Folder | string | Original document folder. |
| storage | Storage | string | Original document storage. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
GetDocumentWithFormatRequest
Represents a request model for WordsApi.GetDocumentWithFormat() operation.
An object of the GetDocumentWithFormatRequest class is created by the following constructor methods:
- GetDocumentWithFormatRequest()
- GetDocumentWithFormatRequest(string name, string format, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string outPath, string fontsLocation)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| name | Name | string | The filename of the input document. |
| format | Format | string | The destination format. |
| folder | Folder | string | Original document folder. |
| storage | Storage | string | Original document storage. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| outPath | OutPath | string | The path to the output document. |
| fontsLocation | FontsLocation | string | Folder in filestorage with custom fonts. |
LoadWebDocumentRequest
Represents a request model for WordsApi.LoadWebDocument() operation.
An object of the LoadWebDocumentRequest class is created by the following constructor methods:
- LoadWebDocumentRequest()
- LoadWebDocumentRequest(LoadWebDocumentData data, string storage)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| data | Data | LoadWebDocumentData | The properties of data downloading. |
| storage | Storage | string | Original document storage. |
OptimizeDocumentOnlineRequest
Represents a request model for WordsApi operation.
An object of the OptimizeDocumentOnlineRequest class is created by the following constructor methods:
- OptimizeDocumentOnlineRequest()
- OptimizeDocumentOnlineRequest(Stream document, OptimizationOptions options, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| document | Document | Stream | The document. |
| options | Options | OptimizationOptions | The document optimization options. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| destFileName | DestFileName | string | Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. |
| revisionAuthor | RevisionAuthor | string | Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. |
| revisionDateTime | RevisionDateTime | string | The date and time to use for revisions. |
OptimizeDocumentRequest
Represents a request model for WordsApi operation.
An object of the OptimizeDocumentRequest class is created by the following constructor methods:
- OptimizeDocumentRequest()
- OptimizeDocumentRequest(string name, OptimizationOptions options, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| name | Name | string | The filename of the input document. |
| options | Options | OptimizationOptions | The document optimization options. |
| folder | Folder | string | Original document folder. |
| storage | Storage | string | Original document storage. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| destFileName | DestFileName | string | Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. |
| revisionAuthor | RevisionAuthor | string | Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. |
| revisionDateTime | RevisionDateTime | string | The date and time to use for revisions. |
SaveAsOnlineRequest
Represents a request model for WordsApi.SaveAsOnline() operation.
An object of the SaveAsOnlineRequest class is created by the following constructor methods:
- SaveAsOnlineRequest()
- SaveAsOnlineRequest(Stream document, SaveOptionsData saveOptionsData, string loadEncoding, string password, string encryptedPassword, string fontsLocation)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| document | Document | Stream | The document. |
| saveOptionsData | SaveOptionsData | SaveOptionsData | Save options. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| fontsLocation | FontsLocation | string | Folder in filestorage with custom fonts. |
SaveAsOnlineResponse
Represents a response model for WordsApi.SaveAsOnline() operation.
An object of the SaveAsOnlineResponse class is created by the following constructor methods:
- SaveAsOnlineResponse(SaveResponse model, Dictionary<string,Stream> document)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| model | Model | SaveResponse | The response model. |
| document | Document | Dictionary<string,Stream> | The document after modification. |
SaveAsRangeOnlineRequest
Represents a request model for WordsApi.SaveAsRangeOnline() operation.
An object of the SaveAsRangeOnlineRequest class is created by the following constructor methods:
- SaveAsRangeOnlineRequest()
- SaveAsRangeOnlineRequest(Stream document, string rangeStartIdentifier, RangeDocument documentParameters, string rangeEndIdentifier, string loadEncoding, string password, string encryptedPassword)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| document | Document | Stream | The document. |
| rangeStartIdentifier | RangeStartIdentifier | string | The range start identifier. |
| documentParameters | DocumentParameters | RangeDocument | Parameters of a new document. |
| rangeEndIdentifier | RangeEndIdentifier | string | The range end identifier. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
SaveAsRangeOnlineResponse
Represents a response model for WordsApi.SaveAsRangeOnline() operation.
An object of the SaveAsRangeOnlineResponse class is created by the following constructor methods:
- SaveAsRangeOnlineResponse(DocumentResponse model, Dictionary<string,Stream> document)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| model | Model | DocumentResponse | The response model. |
| document | Document | Dictionary<string,Stream> | The document after modification. |
SaveAsRangeRequest
Represents a request model for WordsApi.SaveAsRange() operation.
An object of the SaveAsRangeRequest class is created by the following constructor methods:
- SaveAsRangeRequest()
- SaveAsRangeRequest(string name, string rangeStartIdentifier, RangeDocument documentParameters, string rangeEndIdentifier, string folder, string storage, string loadEncoding, string password, string encryptedPassword)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| name | Name | string | The filename of the input document. |
| rangeStartIdentifier | RangeStartIdentifier | string | The range start identifier. |
| documentParameters | DocumentParameters | RangeDocument | Parameters of a new document. |
| rangeEndIdentifier | RangeEndIdentifier | string | The range end identifier. |
| folder | Folder | string | Original document folder. |
| storage | Storage | string | Original document storage. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
SaveAsRequest
Represents a request model for WordsApi.SaveAs() operation.
An object of the SaveAsRequest class is created by the following constructor methods:
- SaveAsRequest()
- SaveAsRequest(string name, SaveOptionsData saveOptionsData, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string fontsLocation)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| name | Name | string | The filename of the input document. |
| saveOptionsData | SaveOptionsData | SaveOptionsData | Save options. |
| folder | Folder | string | Original document folder. |
| storage | Storage | string | Original document storage. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| fontsLocation | FontsLocation | string | Folder in filestorage with custom fonts. |
SaveAsTiffOnlineRequest
Represents a request model for WordsApi.SaveAsTiffOnline() operation.
An object of the SaveAsTiffOnlineRequest class is created by the following constructor methods:
- SaveAsTiffOnlineRequest()
- SaveAsTiffOnlineRequest(Stream document, TiffSaveOptionsData saveOptions, string loadEncoding, string password, string encryptedPassword, bool? useAntiAliasing, bool? useHighQualityRendering, double? imageBrightness, string imageColorMode, double? imageContrast, string numeralFormat, int? pageCount, int? pageIndex, string paperColor, string pixelFormat, double? resolution, double? scale, string tiffCompression, string dmlRenderingMode, string dmlEffectsRenderingMode, string tiffBinarizationMethod, bool? zipOutput, string fontsLocation)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| document | Document | Stream | The document. |
| saveOptions | SaveOptions | TiffSaveOptionsData | Tiff save options. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| useAntiAliasing | UseAntiAliasing | bool? | The flag indicating whether to use antialiasing. |
| useHighQualityRendering | UseHighQualityRendering | bool? | The flag indicating whether to use high quality. |
| imageBrightness | ImageBrightness | double? | The level of brightness for the generated images. |
| imageColorMode | ImageColorMode | string | The color mode for the generated images. |
| imageContrast | ImageContrast | double? | The contrast for the generated images. |
| numeralFormat | NumeralFormat | string | The images numeral format. |
| pageCount | PageCount | int? | The number of pages to render. |
| pageIndex | PageIndex | int? | The index of the page to start rendering. |
| paperColor | PaperColor | string | The background image color. |
| pixelFormat | PixelFormat | string | The pixel format of the generated images. |
| resolution | Resolution | double? | The resolution of the generated images. |
| scale | Scale | double? | The zoom factor for the generated images. |
| tiffCompression | TiffCompression | string | The compression tipe. |
| dmlRenderingMode | DmlRenderingMode | string | The optional dml rendering mode. The default value is Fallback. |
| dmlEffectsRenderingMode | DmlEffectsRenderingMode | string | The optional dml effects rendering mode. The default value is Simplified. |
| tiffBinarizationMethod | TiffBinarizationMethod | string | The optional TIFF binarization method. Possible values are: FloydSteinbergDithering, Threshold. |
| zipOutput | ZipOutput | bool? | The flag indicating whether to ZIP the output. |
| fontsLocation | FontsLocation | string | Folder in filestorage with custom fonts. |
SaveAsTiffOnlineResponse
Represents a response model for WordsApi.SaveAsTiffOnline() operation.
An object of the SaveAsTiffOnlineResponse class is created by the following constructor methods:
- SaveAsTiffOnlineResponse(SaveResponse model, Dictionary<string,Stream> document)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| model | Model | SaveResponse | The response model. |
| document | Document | Dictionary<string,Stream> | The document after modification. |
SaveAsTiffRequest
Represents a request model for WordsApi.SaveAsTiff() operation.
An object of the SaveAsTiffRequest class is created by the following constructor methods:
- SaveAsTiffRequest()
- SaveAsTiffRequest(string name, TiffSaveOptionsData saveOptions, string folder, string storage, string loadEncoding, string password, string encryptedPassword, bool? useAntiAliasing, bool? useHighQualityRendering, double? imageBrightness, string imageColorMode, double? imageContrast, string numeralFormat, int? pageCount, int? pageIndex, string paperColor, string pixelFormat, double? resolution, double? scale, string tiffCompression, string dmlRenderingMode, string dmlEffectsRenderingMode, string tiffBinarizationMethod, bool? zipOutput, string fontsLocation)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| name | Name | string | The filename of the input document. |
| saveOptions | SaveOptions | TiffSaveOptionsData | Tiff save options. |
| folder | Folder | string | Original document folder. |
| storage | Storage | string | Original document storage. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| useAntiAliasing | UseAntiAliasing | bool? | The flag indicating whether to use antialiasing. |
| useHighQualityRendering | UseHighQualityRendering | bool? | The flag indicating whether to use high quality. |
| imageBrightness | ImageBrightness | double? | The level of brightness for the generated images. |
| imageColorMode | ImageColorMode | string | The color mode for the generated images. |
| imageContrast | ImageContrast | double? | The contrast for the generated images. |
| numeralFormat | NumeralFormat | string | The images numeral format. |
| pageCount | PageCount | int? | The number of pages to render. |
| pageIndex | PageIndex | int? | The index of the page to start rendering. |
| paperColor | PaperColor | string | The background image color. |
| pixelFormat | PixelFormat | string | The pixel format of the generated images. |
| resolution | Resolution | double? | The resolution of the generated images. |
| scale | Scale | double? | The zoom factor for the generated images. |
| tiffCompression | TiffCompression | string | The compression tipe. |
| dmlRenderingMode | DmlRenderingMode | string | The optional dml rendering mode. The default value is Fallback. |
| dmlEffectsRenderingMode | DmlEffectsRenderingMode | string | The optional dml effects rendering mode. The default value is Simplified. |
| tiffBinarizationMethod | TiffBinarizationMethod | string | The optional TIFF binarization method. Possible values are: FloydSteinbergDithering, Threshold. |
| zipOutput | ZipOutput | bool? | The flag indicating whether to ZIP the output. |
| fontsLocation | FontsLocation | string | Folder in filestorage with custom fonts. |
SaveResponse
Represents a REST response with a save result.
This class is inherited from WordsResponse and used in WordsApi, SaveAsOnlineResponse, SaveAsTiffOnlineResponse.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| RequestId | string | Gets or sets the request Id. |
| SaveResult | SaveResult | Gets or sets the save result. |
SplitDocumentOnlineRequest
Represents a request model for WordsApi.SplitDocumentOnline() operation.
An object of the SplitDocumentOnlineRequest class is created by the following constructor methods:
- SplitDocumentOnlineRequest()
- SplitDocumentOnlineRequest(Stream document, string format, string loadEncoding, string password, string encryptedPassword, string destFileName, int? from, int? to, bool? zipOutput, string fontsLocation)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| document | Document | Stream | The document. |
| format | Format | string | The format to split. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| destFileName | DestFileName | string | Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. |
| from | From | int? | The start page. |
| to | To | int? | The end page. |
| zipOutput | ZipOutput | bool? | The flag indicating whether to ZIP the output. |
| fontsLocation | FontsLocation | string | Folder in filestorage with custom fonts. |
SplitDocumentOnlineResponse
Represents a response model for WordsApi.SplitDocumentOnline() operation.
An object of the SplitDocumentOnlineResponse class is created by the following constructor methods:
- SplitDocumentOnlineResponse(SplitDocumentResponse model, Dictionary<string,Stream> document)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| model | Model | SplitDocumentResponse | The response model. |
| document | Document | Dictionary<string,Stream> | The document after modification. |
SplitDocumentRequest
Represents a request model for WordsApi.SplitDocument() operation.
An object of the SplitDocumentRequest class is created by the following constructor methods:
- SplitDocumentRequest()
- SplitDocumentRequest(string name, string format, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, int? from, int? to, bool? zipOutput, string fontsLocation)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| name | Name | string | The filename of the input document. |
| format | Format | string | The format to split. |
| folder | Folder | string | Original document folder. |
| storage | Storage | string | Original document storage. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| destFileName | DestFileName | string | Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. |
| from | From | int? | The start page. |
| to | To | int? | The end page. |
| zipOutput | ZipOutput | bool? | The flag indicating whether to ZIP the output. |
| fontsLocation | FontsLocation | string | Folder in filestorage with custom fonts. |
SplitDocumentResponse
Represents a REST response with a result of document splitting.
This class is inherited from WordsResponse and used in WordsApi, SplitDocumentOnlineResponse.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| RequestId | string | Gets or sets the request Id. |
| SplitResult | SplitDocumentResult | Gets or sets the result of document splitting. |
CompareOptions.TargetEnum
The following values are defined: Current, New.
Document.SourceFormatEnum
The following values are defined: Unknown, Doc, Dot, DocPreWord60, Docx, Docm, Dotx, Dotm, FlatOpc, Rtf, WordML, Html, Mhtml, Epub, Text, Odt, Ott, Pdf, Xps, Tiff, Svg.
OptimizationOptions.MsWordVersionEnum
The following values are defined: Word2000, Word2002, Word2003, Word2007, Word2010, Word2013, Word2016, Word2019.