aspose.words.settings module

The aspose.words.settings module contains classes and enums that are used when specifying various settings and options stored in a document. These are mail merge, write protection, compatibility and other settings.

Classes

ClassDescription
CompatibilityOptionsContains compatibility options (that is, the user preferences entered on the Compatibility tab of the Options dialog in Microsoft Word). To learn more, visit the Detect File Format and Check Format Compatibility documentation article.
HyphenationOptionsAllows to configure document hyphenation options. To learn more, visit the Working with Hyphenation documentation article.
MailMergeSettingsSpecifies all of the mail merge information for a document. To learn more, visit the Mail Merge and Reporting documentation article.
OdsoSpecifies the Office Data Source Object (ODSO) settings for a mail merge data source. To learn more, visit the Mail Merge and Reporting documentation article.
OdsoFieldMapDataSpecifies how a column in the external data source shall be mapped to the predefined merge fields within the document. To learn more, visit the Mail Merge and Reporting documentation article.
OdsoFieldMapDataCollectionA typed collection of the OdsoFieldMapData objects. To learn more, visit the Mail Merge and Reporting documentation article.
OdsoRecipientDataRepresents information about a single record within an external data source that is to be excluded from the mail merge. To learn more, visit the Mail Merge and Reporting documentation article.
OdsoRecipientDataCollectionA typed collection of OdsoRecipientData To learn more, visit the Mail Merge and Reporting documentation article.
ViewOptionsProvides various options that control how a document is shown in Microsoft Word. To learn more, visit the Work with Options and Appearance of Word Documents documentation article.
WriteProtectionSpecifies write protection settings for a document. To learn more, visit the Protect or Encrypt a Document documentation article.

Enumerations

EnumerationDescription
CompatibilitySpecifies names of compatibility options.
JustificationModeSpecifies the character spacing adjustment for a document. The default value is Expand.
MailMergeCheckErrorsSpecifies how Microsoft Word will report errors detected during mail merge.
MailMergeDataTypeSpecifies the type of an external mail merge data source.
MailMergeDestinationSpecifies the possible results which may be generated when a mail merge is carried out on a document.
MailMergeMainDocumentTypeSpecifies the possible types for a mail merge source document.
MsWordVersionAllows Aspose.Wods to mimic MS Word version-specific application behavior.
MultiplePagesTypeSpecifies how document is printed out.
OdsoDataSourceTypeSpecifies the type of the external data source to be connected to as part of the ODSO connection information.
OdsoFieldMappingTypeSpecifies the possible types used to indicate if a given mail merge field has been mapped to a column in the given external data source.
ViewTypePossible values for the view mode in Microsoft Word.
ZoomTypePossible values for how large or small the document appears on the screen in Microsoft Word.