The com.aspose.words package provides classes for generating, converting, modifying, rendering and printing Microsoft Word documents without utilizing Microsoft Word.
Aspose.Words is written completely in Java. Microsoft Word is not required in order to use Aspose.Words.
The classes in the com.aspose.words package borrow best practices from two well-known frameworks: Microsoft Word Automation and System.Xml. A document in Aspose.Words is represented by a tree of nodes, much like in XML DOM. Where possible, class, method and property names match those found in Microsoft Word Automation.
The main classes in this namespace are:
The com.aspose.words package also contains classes that form the reporting engine of Aspose.Words. The reporting engine allows to quickly and easily populate documents designed in Microsoft Word with data from various data sources such as java.sql.ResultSet, array of ResultSets, com.aspose.words.net.System.Data.DataSet or an array of values.
The MailMerge object which provides access to the reporting functionality is available via the Document.MailMerge property.
Class Summary | |
---|---|
AbsolutePositionTab |
An absolute position tab is a character which is used to advance the position on
the current line of text when displaying this WordprocessingML content.
|
AsposeWordsPrintDocument |
Provides a default implementation for printing of a |
AxisBound |
Represents minimum or maximum bound of axis values.
|
AxisDisplayUnit |
Provides access to the scaling options of the display units for the value axis.
|
AxisScaling |
Represents the scaling options of the axis.
|
BarcodeParameters |
Container class for barcode parameters to pass-through to BarcodeGenerator.
|
BaseWebExtensionCollection |
Base class for |
BasicTextShaperCache | |
Body |
Represents a container for the main text of a section.
|
Bookmark |
Represents a single bookmark.
|
BookmarkCollection |
A collection of |
BookmarkEnd |
Represents an end of a bookmark in a Word document.
|
BookmarksOutlineLevelCollection |
A collection of individual bookmarks outline level.
|
BookmarkStart |
Represents a start of a bookmark in a Word document.
|
Border |
Represents a border of an object.
|
BorderCollection |
A collection of Border objects.
|
BuildingBlock |
Represents a glossary document entry such as a Building Block, AutoText or an AutoCorrect entry.
|
BuildingBlockCollection |
A collection of |
BuildVersionInfo |
Provides information about the current product name and version.
|
BuiltInDocumentProperties |
A collection of built-in document properties.
|
Cell |
Represents a table cell.
|
CellCollection |
Provides typed access to a collection of |
CellFormat |
Represents all formatting for a table cell.
|
CertificateHolder |
Represents a holder of X509Certificate2 instance.
|
Chart |
Provides access to the chart shape properties.
|
ChartAxis |
Represents the axis options of the chart.
|
ChartDataLabel |
Represents data label on a chart point or trendline.
|
ChartDataLabelCollection |
Represents a collection of |
ChartDataPoint |
Allows to specify formatting of a single data point on the chart.
|
ChartDataPointCollection |
Represents collection of a |
ChartLegend |
Represents chart legend properties.
|
ChartMarker |
Represents a chart data marker.
|
ChartNumberFormat |
Represents number formatting of the parent element.
|
ChartSeries |
Represents chart series properties.
|
ChartSeriesCollection |
Represents collection of a |
ChartTitle |
Provides access to the chart title properties.
|
CleanupOptions |
Allows to specify options for document cleaning.
|
Cluster | |
Comment |
Represents a container for text of a comment.
|
CommentCollection |
Provides typed access to a collection of |
CommentRangeEnd |
Denotes the end of a region of text that has a comment associated with it.
|
CommentRangeStart |
Denotes the start of a region of text that has a comment associated with it.
|
CompareOptions |
Allows to choose advanced options for document comparison operation.
|
ComparisonEvaluationResult |
The comparison evaluation result.
|
ComparisonExpression |
The comparison expression.
|
CompatibilityOptions |
Contains compatibility options (that is, the user preferences entered on the Compatibility
tab of the Options dialog in Microsoft Word).
|
CompositeNode |
Base class for nodes that can contain other nodes.
|
ConditionalStyle |
Represents special formatting applied to some area of a table with assigned table style.
|
ConditionalStyleCollection |
Represents a collection of |
ConvertUtil |
Provides helper functions to convert between various measurement units.
|
CssSavingArgs |
Provides data for the |
CsvDataLoadOptions |
Represents options for parsing CSV data.
|
CsvDataSource |
Provides access to data of a CSV file or stream to be used within a report.
|
CustomDocumentProperties |
A collection of custom document properties.
|
CustomPart |
Represents a custom (arbitrary content) part, that is not defined by the ISO/IEC 29500 standard.
|
CustomPartCollection |
Represents a collection of |
CustomXmlPart |
Represents a Custom XML Data Storage Part (custom XML data within a package).
|
CustomXmlPartCollection |
Represents a collection of Custom XML Parts. The items are |
CustomXmlProperty |
Represents a single custom XML attribute or a smart tag property.
|
CustomXmlPropertyCollection |
Represents a collection of custom XML attributes or smart tag properties.
|
CustomXmlSchemaCollection |
A collection of strings that represent XML schemas that are associated with a custom XML part.
|
DefaultFontSubstitutionRule |
Default font substitution rule.
|
DigitalSignature |
Represents a digital signature on a document and the result of its verification.
|
DigitalSignatureCollection |
Provides a read-only collection of digital signatures attached to a document.
|
DigitalSignatureUtil |
Provides methods for signing document.
|
DocSaveOptions |
Can be used to specify additional options when saving a document into the |
Document |
Represents a Word document.
|
DocumentBase |
Provides the abstract base class for a main document and a glossary document of a Word document.
|
DocumentBuilder |
Provides methods to insert text, images and other content, specify font, paragraph and section formatting.
|
DocumentPartSavingArgs |
Provides data for the |
DocumentProperty |
Represents a custom or built-in document property.
|
DocumentPropertyCollection |
Base class for |
DocumentVisitor |
Base class for custom document visitors.
|
DownsampleOptions |
Allows to specify downsample options.
|
DropDownItemCollection |
A collection of strings that represent all the items in a drop-down form field.
|
EditableRange |
Represents a single editable range.
|
EditableRangeEnd |
Represents an end of an editable range in a Word document.
|
EditableRangeStart |
Represents a start of an editable range in a Word document.
|
EndnoteOptions |
Represents the endnote numbering options for a document or section.
|
Field |
Represents a Microsoft Word document field.
|
FieldAddIn |
Implements the ADDIN field.
|
FieldAddressBlock |
Implements the ADDRESSBLOCK field.
|
FieldAdvance |
Implements the ADVANCE field.
|
FieldArgumentBuilder |
Builds a complex field argument consisting of fields, nodes, and plain text.
|
FieldAsk |
Implements the ASK field.
|
FieldAuthor |
Implements the AUTHOR field.
|
FieldAutoNum |
Implements the AUTONUM field.
|
FieldAutoNumLgl |
Implements the AUTONUMLGL field.
|
FieldAutoNumOut |
Implements the AUTONUMOUT field.
|
FieldAutoText |
Implements the AUTOTEXT field.
|
FieldAutoTextList |
Implements the AUTOTEXTLIST field.
|
FieldBarcode |
Implements the BARCODE field.
|
FieldBibliography |
Implements the BIBLIOGRAPHY field.
|
FieldBidiOutline |
Implements the BIDIOUTLINE field.
|
FieldBuilder |
Builds a field from field code tokens (arguments and switches).
|
FieldChar |
Base class for nodes that represent field characters in a document.
|
FieldCitation |
Implements the CITATION field.
|
FieldCollection |
A collection of |
FieldComments |
Implements the COMMENTS field.
|
FieldCompare |
Implements the COMPARE field.
|
FieldCreateDate |
Implements the CREATEDATE field.
|
FieldData |
Implements the DATA field.
|
FieldDatabase |
Implements the DATABASE field.
|
FieldDate |
Implements the DATE field.
|
FieldDde |
Implements the DDE field.
|
FieldDdeAuto |
Implements the DDEAUTO field.
|
FieldDisplayBarcode |
Implements the DISPLAYBARCODE field.
|
FieldDocProperty |
Implements the DOCPROPERTY field.
|
FieldDocVariable |
Implements DOCVARIABLE field.
|
FieldEditTime |
Implements the EDITTIME field.
|
FieldEmbed |
Implements the EMBED field.
|
FieldEnd |
Represents an end of a Word field in a document.
|
FieldEQ |
Implements the EQ field.
|
FieldFileName |
Implements the FILENAME field.
|
FieldFileSize |
Implements the FILESIZE field.
|
FieldFillIn |
Implements the FILLIN field.
|
FieldFootnoteRef |
Implements the FOOTNOTEREF field.
|
FieldFormat |
Provides typed access to field's numeric, date and time, and general formatting.
|
FieldFormCheckBox |
Implements the FORMCHECKBOX field.
|
FieldFormDropDown |
Implements the FORMDROPDOWN field.
|
FieldFormText |
Implements the FORMTEXT field.
|
FieldFormula |
Implements the = (formula) field.
|
FieldGlossary |
Implements the GLOSSARY field.
|
FieldGoToButton |
Implements the GOTOBUTTON field.
|
FieldGreetingLine |
Implements the GREETINGLINE field.
|
FieldHyperlink |
Implements the HYPERLINK field
|
FieldIf |
Implements the IF field.
|
FieldImport |
Implements the IMPORT field.
|
FieldInclude |
Implements the INCLUDE field.
|
FieldIncludePicture |
Implements the INCLUDEPICTURE field.
|
FieldIncludeText |
Implements the INCLUDETEXT field.
|
FieldIndex |
Implements the INDEX field.
|
FieldInfo |
Implements the INFO field.
|
FieldKeywords |
Implements the KEYWORDS field.
|
FieldLastSavedBy |
Implements the LASTSAVEDBY field.
|
FieldLink |
Implements the LINK field.
|
FieldListNum |
Implements the LISTNUM field.
|
FieldMacroButton |
Implements the MACROBUTTON field.
|
FieldMergeBarcode |
Implements the MERGEBARCODE field.
|
FieldMergeField |
Implements the MERGEFIELD field.
|
FieldMergeRec |
Implements the MERGEREC field.
|
FieldMergeSeq |
Implements the MERGESEQ field.
|
FieldMergingArgs |
Provides data for the MergeField event.
|
FieldMergingArgsBase |
Base class for |
FieldNext |
Implements the NEXT field.
|
FieldNextIf |
Implements the NEXTIF field.
|
FieldNoteRef |
Implements the NOTEREF field.
|
FieldNumChars |
Implements the NUMCHARS field.
|
FieldNumPages |
Implements the NUMPAGES field.
|
FieldNumWords |
Implements the NUMWORDS field.
|
FieldOcx |
Implements the OCX field.
|
FieldOptions |
Represents options to control field handling in a document.
|
FieldPage |
Implements the PAGE field.
|
FieldPageRef |
Implements the PAGEREF field.
|
FieldPrint |
Implements the PRINT field.
|
FieldPrintDate |
Implements the PRINTDATE field.
|
FieldPrivate |
Implements the PRIVATE field.
|
FieldQuote |
Implements the QUOTE field.
|
FieldRD |
Implements the RD field.
|
FieldRef |
Implements the REF field.
|
FieldRevNum |
Implements the REVNUM field.
|
FieldSaveDate |
Implements the SAVEDATE field.
|
FieldSection |
Implements the SECTION field.
|
FieldSectionPages |
Implements the SECTIONPAGES field.
|
FieldSeparator |
Represents a Word field separator that separates the field code from the field result.
|
FieldSeq |
Implements the SEQ field.
|
FieldSet |
Implements the SET field.
|
FieldShape |
Implements the SHAPE field.
|
FieldSkipIf |
Implements the SKIPIF field.
|
FieldStart |
Represents a start of a Word field in a document.
|
FieldStyleRef |
Implements the STYLEREF field.
|
FieldSubject |
Implements the SUBJECT field.
|
FieldSymbol |
Implements a SYMBOL field.
|
FieldTA |
Implements the TA field.
|
FieldTC |
Implements the TC field.
|
FieldTemplate |
Implements the TEMPLATE field.
|
FieldTime |
Implements the TIME field.
|
FieldTitle |
Implements the TITLE field.
|
FieldToa |
Implements the TOA field.
|
FieldToc |
Implements the TOC field.
|
FieldUnknown |
Implements an unknown or unrecognized field.
|
FieldUserAddress |
Implements the USERADDRESS field.
|
FieldUserInitials |
Implements the USERINITIALS field.
|
FieldUserName |
Implements the USERNAME field.
|
FieldXE |
Implements the XE field.
|
FileFontSource |
Represents the single TrueType font file stored in the file system.
|
FileFormatInfo |
Contains data returned by |
FileFormatUtil |
Provides utility methods for working with file formats, such as detecting file format
or converting file extensions to/from file format enums.
|
Fill |
Defines a fill for a shape.
|
FindReplaceOptions |
Specifies options for find/replace operations.
|
FixedPageSaveOptions |
Contains common options that can be specified when saving a document into fixed page formats (PDF, XPS,
images etc).
|
FolderFontSource |
Represents the folder that contains TrueType font files.
|
Font |
Contains font attributes (font name, font size, color, and so on) for an object.
|
FontConfigSubstitutionRule |
Font config substitution rule.
|
FontFallbackSettings |
Specifies font fallback mechanism settings.
|
FontInfo |
Specifies information about a font used in the document.
|
FontInfoCollection |
Represents a collection of fonts used in a document.
|
FontInfoSubstitutionRule |
Font info substitution rule.
|
FontNameSubstitutionRule |
Font substitution rule for processing font name.
|
FontSavingArgs |
Provides data for the |
FontSettings |
Specifies font settings for a document.
|
FontSourceBase |
This is an abstract base class for the classes that allow the user to specify various font sources.
|
FontSubstitutionRule |
This is an abstract base class for the font substitution rule.
|
FontSubstitutionSettings |
Specifies font substitution mechanism settings.
|
Footnote |
Represents a container for text of a footnote or endnote.
|
FootnoteOptions |
Represents the footnote numbering options for a document or section.
|
FormField |
Represents a single form field.
|
FormFieldCollection |
A collection of FormField objects that represent all the form fields in a range.
|
Forms2OleControl |
Represents Microsoft Forms 2.0 OLE control.
|
Forms2OleControlCollection |
Represents collection of |
FrameFormat |
Represents frame related formatting for a paragraph.
|
GeneralFormatCollection |
Represents a typed collection of general formats.
|
GlossaryDocument |
Represents the root element for a glossary document within a Word document.
A glossary document is a storage for AutoText, AutoCorrect entries and Building Blocks.
|
Glyph | |
GraphicsQualityOptions |
Allows to specify additional |
GroupShape |
Represents a group of shapes in a document.
|
HeaderFooter |
Represents a container for the header or footer text of a section.
|
HeaderFooterCollection |
Provides typed access to |
HorizontalRuleFormat |
Represents horizontal rule formatting.
|
HtmlFixedSaveOptions |
Can be used to specify additional options when saving a document into the |
HtmlLoadOptions |
Allows to specify additional options when loading HTML document into a |
HtmlSaveOptions |
Can be used to specify additional options when saving a document into the |
Hyphenation |
Provides methods for working with hyphenation dictionaries. These dictionaries prescribe where words of a specific language can be hyphenated.
|
HyphenationOptions |
Allows to configure document hyphenation options.
|
ImageData |
Defines an image for a shape.
|
ImageFieldMergingArgs |
Provides data for the |
ImageSaveOptions |
Allows to specify additional options when rendering document pages or shapes to images.
|
ImageSavingArgs |
Provides data for the |
ImageSize |
Contains information about image size and resolution.
|
ImageWatermarkOptions |
Contains options that can be specified when adding a watermark with image.
|
ImportFormatOptions |
Allows to specify various import options to format output.
|
Inline |
Base class for inline-level nodes that can have character formatting associated with them, but cannot have child nodes of their own.
|
InlineStory |
Base class for inline-level nodes that can contain paragraphs and tables.
|
InternableComplexAttr |
Base class for internable complex attribute.
Internable complex attribute should notify parent collection when going to be changed.
|
JsonDataLoadOptions |
Represents options for parsing JSON data.
|
JsonDataSource |
Provides access to data of a JSON file or stream to be used within a report.
|
KnownTypeSet |
Represents an unordered set (i.e. a collection of unique items) containing |
LanguagePreferences |
Allows to set up language preferences.
|
LayoutCollector | This class allows to compute page numbers of document nodes. |
LayoutEnumerator |
Enumerates page layout entities of a document.
You can use this class to walk over the page layout model. Available properties are type, geometry, text and page index where entity is rendered,
as well as overall structure and relationships.
Use combination of |
LayoutOptions |
Holds the options that allow controlling the document layout process.
|
License |
Provides methods to license the component.
|
List |
Represents formatting of a list.
|
ListCollection |
Stores and manages formatting of bulleted and numbered lists used in a document.
|
ListFormat |
Allows to control what list formatting is applied to a paragraph.
|
ListLabel |
Defines properties specific to a list label.
|
ListLevel |
Defines formatting for a list level.
|
ListLevelCollection |
A collection of list formatting for each level in a list.
|
LoadOptions |
Allows to specify additional options (such as password or base URI) when
loading a document into a |
MailMerge |
Represents the mail merge functionality.
|
MailMergeRegionInfo |
Contains information about a mail merge region.
|
MailMergeSettings |
Specifies all of the mail merge information for a document.
|
MappedDataFieldCollection |
Allows to automatically map between names of fields in your data source
and names of mail merge fields in the document.
|
MarkdownSaveOptions |
Class to specify additional options when saving a document into the |
MemoryFontSource |
Represents the single TrueType font file stored in memory.
|
MergeFieldImageDimension |
Represents an image dimension (i.e. the width or the height) used across a mail merge process.
|
MetafileRenderingOptions |
Allows to specify additional metafile rendering options.
|
Metered |
Provides methods to set metered key.
|
Node |
Base class for all nodes of a Word document.
|
NodeChangingArgs |
Provides data for methods of the |
NodeCollection |
Represents a collection of nodes of a specific type.
|
NodeImporter |
Allows to efficiently perform repeated import of nodes from one document to another.
|
NodeList |
Represents a collection of nodes matching an XPath query executed using the |
NodeRendererBase |
Base class for |
Odso |
Specifies the Office Data Source Object (ODSO) settings for a mail merge data source.
|
OdsoFieldMapData |
Specifies how a column in the external data source shall be mapped to the predefined merge fields within the document.
|
OdsoFieldMapDataCollection |
A typed collection of the |
OdsoRecipientData |
Represents information about a single record within an external data source that is to be excluded from the mail merge.
|
OdsoRecipientDataCollection |
A typed collection of |
OdtSaveOptions |
Can be used to specify additional options when saving a document into the |
OfficeMath |
Represents an Office Math object such as function, equation, matrix or alike. Can contain child elements
including runs of mathematical text, bookmarks, comments, other |
OfficeMathRenderer |
Provides methods to render an individual |
OleControl |
Represents OLE ActiveX control.
|
OleFormat |
Provides access to the data of an OLE object or ActiveX control.
|
OlePackage |
Allows to access OLE Package properties.
|
OoxmlSaveOptions |
Can be used to specify additional options when saving a document into the |
OutlineOptions |
Allows to specify outline options.
|
PageInfo |
Represents information about a particular document page.
|
PageLayoutCallbackArgs |
An argument passed into |
PageRange |
Represents a continuous range of pages.
|
PageSavingArgs |
Provides data for the |
PageSet |
Describes a random set of pages.
|
PageSetup |
Represents the page setup properties of a section.
|
Paragraph |
Represents a paragraph of text.
|
ParagraphCollection |
Provides typed access to a collection of |
ParagraphFormat |
Represents all the formatting for a paragraph.
|
PclSaveOptions |
Can be used to specify additional options when saving a document into the |
PdfDigitalSignatureDetails |
Contains details for signing a PDF document with a digital signature.
|
PdfDigitalSignatureTimestampSettings |
Contains settings of the digital signature timestamp.
|
PdfEncryptionDetails |
Contains details for encrypting and access permissions for a PDF document.
|
PdfLoadOptions |
Allows to specify additional options when loading Pdf document into a |
PdfSaveOptions |
Can be used to specify additional options when saving a document into the |
PhysicalFontInfo |
Specifies information about physical font available to Aspose.Words font engine.
|
PlainTextDocument |
Allows to extract plain-text representation of the document's content.
|
PreferredWidth |
Represents a value and its unit of measure that is used to specify the preferred width of a table or a cell.
|
PsSaveOptions |
Can be used to specify additional options when saving a document into the |
Range |
Represents a contiguous area in a document.
|
ReplacingArgs |
Provides data for a custom replace operation.
|
ReportingEngine |
Provides routines to populate template documents with data and a set of settings to control these routines.
|
ResourceLoadingArgs |
Provides data for the |
ResourceSavingArgs |
Provides data for the |
Revision |
Represents a revision (tracked change) in a document node or style.
Use |
RevisionCollection |
A collection of |
RevisionGroup |
Represents a group of sequential |
RevisionGroupCollection |
A collection of |
RevisionOptions |
Allows to control how document revisions are handled during layout process.
|
Row |
Represents a table row.
|
RowCollection |
Provides typed access to a collection of |
RowFormat |
Represents all formatting for a table row.
|
RtfLoadOptions |
Allows to specify additional options when loading |
RtfSaveOptions |
Can be used to specify additional options when saving a document into the |
Run |
Represents a run of characters with the same font formatting.
|
RunCollection |
Provides typed access to a collection of |
SaveOptions |
This is an abstract base class for classes that allow the user to specify additional
options when saving a document into a particular format.
|
SaveOutputParameters |
This object is returned to the caller after a document is saved and contains additional information that
has been generated or calculated during the save operation. The caller can use or ignore this object.
|
SdtListItem |
This element specifies a single list item within a parent |
SdtListItemCollection |
Provides access to |
Section |
Represents a single section in a document.
|
SectionCollection |
A collection of Section objects in the document.
|
Shading |
Contains shading attributes for an object.
|
Shape |
Represents an object in the drawing layer, such as an AutoShape, textbox, freeform, OLE object, ActiveX control, or picture.
|
ShapeBase |
Base class for objects in the drawing layer, such as an AutoShape, freeform, OLE object, ActiveX control, or picture.
|
ShapeRenderer |
Provides methods to render an individual |
SignatureLine |
Provides access to signature line properties.
|
SignatureLineOptions |
Allows to specify options for signature line being inserted. Used in |
SignOptions |
Allows to specify options for document signing.
|
SmartTag |
This element specifies the presence of a smart tag around one or more inline structures
(runs, images, fields,etc.) within a paragraph.
|
SpecialChar |
Base class for special characters in the document.
|
Story | |
StreamFontSource |
Base class for user-defined stream font source.
|
Stroke |
Defines a stroke for a shape.
|
StructuredDocumentTag |
Represents a structured document tag (SDT or content control) in a document.
|
StructuredDocumentTagRangeEnd |
Represents an end of ranged structured document tag which accepts multi-sections content.
See also |
StructuredDocumentTagRangeStart |
Represents a start of ranged structured document tag which accepts multi-sections content.
See also |
Style |
Represents a single built-in or user-defined style.
|
StyleCollection |
A collection of Style objects that represent both the built-in and user-defined styles in a document.
|
SubDocument |
Represents a SubDocument - which is a reference to an externally stored document.
|
SvgSaveOptions |
Can be used to specify additional options when saving a document into the |
SystemFontSource |
Represents all TrueType fonts installed to the system.
|
Table |
Represents a table in a Word document.
|
TableCollection |
Provides typed access to a collection of |
TableStyle |
Represents a table style.
|
TableSubstitutionRule |
Table font substitution rule.
|
TabStop |
Represents a single custom tab stop. The TabStop object is a member of the
|
TabStopCollection |
A collection of |
TaskPane |
Represents an add-in task pane object.
|
TaskPaneCollection |
Specifies a list of persisted task pane objects.
|
TextBox |
Defines attributes that specify how a text is displayed inside a shape.
|
TextColumn |
Represents a single text column. TextColumn is a member of the |
TextColumnCollection |
A collection of |
TextPath |
Defines the text and formatting of the text path (of a WordArt object).
|
TextWatermarkOptions |
Contains options that can be specified when adding a watermark with text.
|
Theme |
Represents document Theme, and provides access to main theme parts including |
ThemeColors | Represents the color scheme of the document theme which contains twelve colors. ThemeColors object contains six accent colors, two dark colors, two light colors and a color for each of a hyperlink and followed hyperlink. |
ThemeFonts |
Represents a collection of fonts in the font scheme, allowing to specify different fonts for different languages |
ThumbnailGeneratingOptions |
Can be used to specify additional options when generating thumbnail for a document.
|
ToaCategories |
Represents a table of authorities categories.
|
TxtListIndentation |
Specifies how list levels are indented when document is exporting to |
TxtLoadOptions |
Allows to specify additional options when loading |
TxtSaveOptions |
Can be used to specify additional options when saving a document into the |
TxtSaveOptionsBase |
The base class for specifying additional options when saving a document into a text based formats.
|
UserInformation |
Specifies information about the user.
|
VariableCollection |
A collection of document variables.
|
VbaModule |
Provides access to VBA project module.
|
VbaModuleCollection |
Represents a collection of |
VbaProject |
Provides access to VBA project information.
A VBA project inside the document is defined as a collection of VBA modules.
|
VbaReference |
Implements a reference to an Automation type library or VBA project.
|
VbaReferenceCollection |
Represents a collection of |
ViewOptions |
Provides various options that control how a document is shown in Microsoft Word.
|
WarningInfo |
Contains information about a warning that Aspose.Words issued during document loading or saving.
|
WarningInfoCollection |
Represents a typed collection of |
Watermark |
Represents class to work with document watermark.
|
WebExtension |
Represents a web extension object.
|
WebExtensionBinding |
Specifies a binding relationship between a web extension and the data in the document.
|
WebExtensionBindingCollection |
Specifies a list of web extension bindings.
|
WebExtensionProperty |
Specifies a web extension custom property.
|
WebExtensionPropertyCollection |
Specifies a set of web extension custom properties.
|
WebExtensionReference |
Represents the reference to a web extension. The reference is used to identify the provider location and version of the
extension.
|
WebExtensionReferenceCollection |
Specifies a list of web extension references.
|
WordML2003SaveOptions |
Can be used to specify additional options when saving a document into the |
WriteProtection |
Specifies write protection settings for a document.
|
XamlFixedSaveOptions |
Can be used to specify additional options when saving a document into the |
XamlFlowSaveOptions |
Can be used to specify additional options when saving a document into the
|
XmlDataSource |
Provides access to data of an XML file or stream to be used within a report.
|
XmlMapping |
Specifies the information that is used to establish a mapping between the parent
structured document tag and an XML element stored within a custom XML data part in the document.
|
XpsSaveOptions |
Can be used to specify additional options when saving a document into the |
Interface Summary | |
---|---|
IBarcodeGenerator |
Public interface for barcode custom generator. Implementation should be provided by user.
|
IChartDataPoint |
Contains properties of a single data point on the chart.
|
IComparisonExpressionEvaluator |
When implemented, allows to override default comparison expressions evaluation for the |
ICssSavingCallback |
Implement this interface if you want to control how Aspose.Words saves CSS (Cascading Style Sheet) when
saving a document to HTML.
|
IDocumentPartSavingCallback |
Implement this interface if you want to receive notifications and control how
Aspose.Words saves document parts when exporting a document to |
IDocumentReaderPlugin |
Defines an interface for external reader plugins that can read a file into a document.
|
IFieldMergingCallback |
Implement this interface if you want to control how data is inserted into merge fields during a mail merge operation.
|
IFieldResultFormatter |
Implement this interface if you want to control how the field result is formatted.
|
IFieldUpdateCultureProvider |
When implemented, provides a |
IFieldUserPromptRespondent |
Represents the respondent to user prompts during field update.
|
IFontSavingCallback |
Implement this interface if you want to receive notifications and control how
Aspose.Words saves fonts when exporting a document to HTML format.
|
IHyphenationCallback |
Implemented by classes which can register hyphenation dictionaries.
|
IImageSavingCallback |
Implement this interface if you want to control how Aspose.Words saves images when
saving a document to HTML. May be used by other formats.
|
IMailMergeCallback |
Implement this interface if you want to receive notifications while mail merge is performed.
|
IMailMergeDataSource |
Implement this interface to allow mail merge from a custom data source, such as a list of objects. Master-detail data is also supported.
|
IMailMergeDataSourceRoot |
Implement this interface to allow mail merge from a custom data source with master-detail data.
|
INodeChangingCallback |
Implement this interface if you want to receive notifications when nodes are inserted or removed in the document.
|
IPageLayoutCallback |
Implement this interface if you want to have your own custom method called during build and rendering of page layout model.
|
IPageSavingCallback |
Implement this interface if you want to control how Aspose.Words saves separate pages when
saving a document to fixed page formats.
|
IReplacingCallback |
Implement this interface if you want to have your own custom method called during a find and replace operation.
|
IResourceLoadingCallback |
Implement this interface if you want to control how Aspose.Words loads external resource when
importing a document and inserting images using |
IResourceSavingCallback |
Implement this interface if you want to control how Aspose.Words saves external resources (images, fonts and css) when
saving a document to fixed page HTML or SVG.
|
ITextShaper | |
ITextShaperFactory | |
IWarningCallback |
Implement this interface if you want to have your own custom method called to
capture loss of fidelity warnings that can occur during document loading or saving.
|
Exception Summary | |
---|---|
DocumentReaderPluginLoadException |
Thrown during document load, when the plugin required for reading the document format cannot be loaded.
|
FileCorruptedException |
Thrown during document load, when the document appears to be corrupted and impossible to load.
|
IncorrectPasswordException |
Thrown if a document is encrypted with a password and the password specified when opening the document is incorrect or missing.
|
UnsupportedFileFormatException |
Thrown during document load, when the document format is not recognized or not supported by Aspose.Words.
|
Constant Summary | |
---|---|
ArrowLength | Utility class containing constants.
Length of the arrow at the end of a line.
|
ArrowType | Utility class containing constants.
Specifies the type of an arrow at a line end.
|
ArrowWidth | Utility class containing constants.
Width of the arrow at the end of a line.
|
AutoFitBehavior | Utility class containing constants.
Determines how Aspose.Words resizes the table when you invoke the |
AxisBuiltInUnit | Utility class containing constants.
Specifies the display units for an axis.
|
AxisCategoryType | Utility class containing constants.
Specifies type of a category axis.
|
AxisCrosses | Utility class containing constants.
Specifies the possible crossing points for an axis.
|
AxisScaleType | Utility class containing constants.
Specifies the possible scale types for an axis.
|
AxisTickLabelPosition | Utility class containing constants.
Specifies the possible positions for tick labels.
|
AxisTickMark | Utility class containing constants.
Specifies the possible positions for tick marks.
|
AxisTimeUnit | Utility class containing constants.
Specifies the unit of time for axes.
|
BorderType | Utility class containing constants.
Specifies sides of a border.
|
BreakType | Utility class containing constants.
Specifies type of a break inside a document.
|
BuildingBlockBehavior | Utility class containing constants.
Specifies the behavior that shall be applied to the contents of the building block
when it is inserted into the main document.
|
BuildingBlockGallery | Utility class containing constants.
Specifies the predefined gallery into which a building block is classified.
|
BuildingBlockType | Utility class containing constants.
Specifies a building block type. The type might affect the visibility and behavior of the building block
in Microsoft Word.
|
CalendarType | Utility class containing constants.
Specifies the type of a calendar.
|
CellMerge | Utility class containing constants.
Specifies how a cell in a table is merged with other cells.
|
CellVerticalAlignment | Utility class containing constants.
Specifies vertical justification of text inside a table cell.
|
ChartAxisType | Utility class containing constants.
Specifies type of chart axis.
|
ChartType | Utility class containing constants.
Specifies type of a chart.
|
ColorMode | Utility class containing constants.
Specifies how colors are rendered.
|
ComparisonTargetType | Utility class containing constants.
Allows to specify base document which will be used during comparison. Default value is |
Compatibility | Utility class containing constants.
Specifies names of compatibility options.
|
CompressionLevel | Utility class containing constants.
Compression level for OOXML files.
(DOCX and DOTX files are internally a ZIP-archive, this property controls the compression level of the archive. Note, that FlatOpc file is not a ZIP-archive, therefore, this property does not affect the FlatOpc files.) |
ConditionalStyleType | Utility class containing constants.
Represents possible table areas to which conditional formatting may be defined in a table style.
|
ContentDisposition | Utility class containing constants.
Enumerates different ways of presenting the document at the client browser.
|
ControlChar | Utility class containing constants.
Control characters often encountered in documents.
|
CssStyleSheetType | Utility class containing constants.
Specifies how CSS (Cascading Style Sheet) styles are exported to HTML.
|
DashStyle | Utility class containing constants.
Dashed line style.
|
DigitalSignatureType | Utility class containing constants.
Specifies the type of a digital signature.
|
Direction | Utility class containing constants. |
Dml3DEffectsRenderingMode | Utility class containing constants.
Specifies how 3D shape effects are rendered.
|
DmlEffectsRenderingMode | Utility class containing constants.
Specifies how DrawingML effects are rendered to fixed page formats.
|
DmlRenderingMode | Utility class containing constants.
Specifies how DrawingML shapes are rendered to fixed page formats.
|
DocumentDirection | Utility class containing constants.
Allows to specify the direction to flow the text in a document.
|
DocumentSecurity | Utility class containing constants.
Used as a value for the |
DocumentSplitCriteria | Utility class containing constants.
Specifies how the document is split into parts when saving to |
DropCapPosition | Utility class containing constants.
Specifies the position for a drop cap text.
|
EditingLanguage | Utility class containing constants.
Specifies the editing language.
|
EditorType | Utility class containing constants.
Specifies the set of possible aliases (or editing groups) which can be used as aliases to
determine if the current user shall be allowed to edit a single range
defined by an editable range within a document.
|
EmbeddedFontFormat | Utility class containing constants. Specifies format of particular embedded font inside When saving a document to a file, only embedded fonts of corresponding format are written down. |
EmbeddedFontStyle | Utility class containing constants.
Specifies the style of an embedded font inside a |
EmfPlusDualRenderingMode | Utility class containing constants.
Specifies how Aspose.Words should render EMF+ Dual metafiles.
|
EmphasisMark | Utility class containing constants.
Specifies possible types of emphasis mark.
|
EndCap | Utility class containing constants.
Specifies line cap style.
|
EndnotePosition | Utility class containing constants.
Defines the endnote position.
|
ExportFontFormat | Utility class containing constants.
Indicates the format that is used to export fonts while rendering to HTML fixed format.
|
ExportHeadersFootersMode | Utility class containing constants.
Specifies how headers and footers are exported to HTML, MHTML or EPUB.
|
ExportListLabels | Utility class containing constants.
Specifies how list labels are exported to HTML, MHTML and EPUB.
|
FieldIfComparisonResult | Utility class containing constants.
Specifies the result of the IF field condition evaluation.
|
FieldIndexFormat | Utility class containing constants.
Specifies the formatting for the |
FieldType | Utility class containing constants.
Specifies Microsoft Word field types.
|
FieldUpdateCultureSource | Utility class containing constants.
Indicates what culture to use during field update.
|
FindReplaceDirection | Utility class containing constants.
Specifies direction for replace operations.
|
FlipOrientation | Utility class containing constants.
Possible values for the orientation of a shape.
|
FontFamily | Utility class containing constants.
Represents the font family.
|
FontFeature | Utility class containing constants. |
FontPitch | Utility class containing constants.
Represents the font pitch.
|
FontSourceType | Utility class containing constants.
Specifies the type of a font source.
|
FootnoteNumberingRule | Utility class containing constants.
Determines when automatic footnote or endnote numbering restarts.
|
FootnotePosition | Utility class containing constants.
Defines the footnote position.
|
FootnoteType | Utility class containing constants.
Specifies whether this is a footnote or an endnote.
|
Forms2OleControlType | Utility class containing constants. |
GeneralFormat | Utility class containing constants.
Specifies a general format that is applied to a numeric, text, or any field result.
A field may have a combination of general formats.
|
Granularity | Utility class containing constants.
Specifies the granularity of changes to track when comparing two documents.
|
HeaderFooterBookmarksExportMode | Utility class containing constants.
Specifies how bookmarks in headers/footers are exported.
|
HeaderFooterType | Utility class containing constants.
Identifies the type of header or footer found in a Word file.
|
HeightRule | Utility class containing constants.
Specifies the rule for determining the height of an object.
|
HorizontalAlignment | Utility class containing constants.
Specifies horizontal alignment of a floating shape, text frame or floating table.
|
HorizontalRuleAlignment | Utility class containing constants.
Represents the alignment for the specified horizontal rule.
|
HtmlControlType | Utility class containing constants.
Type of document nodes that represent <input> and <select> elements imported from HTML.
|
HtmlElementSizeOutputMode | Utility class containing constants.
Specifies how Aspose.Words exports element widths and heights to HTML, MHTML and EPUB.
|
HtmlFixedPageHorizontalAlignment | Utility class containing constants.
Specifies the horizontal alignment for pages in output HTML document.
|
HtmlMetafileFormat | Utility class containing constants.
Indicates the format in which metafiles are saved to HTML documents.
|
HtmlOfficeMathOutputMode | Utility class containing constants.
Specifies how Aspose.Words exports OfficeMath to HTML, MHTML and EPUB.
|
HtmlVersion | Utility class containing constants.
Indicates the version of HTML is used when saving the document to |
ImageBinarizationMethod | Utility class containing constants.
Specifies the method used to binarize image.
|
ImageColorMode | Utility class containing constants.
Specifies the color mode for the generated images of document pages.
|
ImagePixelFormat | Utility class containing constants.
Specifies the pixel format for the generated images of document pages.
|
ImageType | Utility class containing constants.
Specifies the type (format) of an image in a Microsoft Word document.
|
ImportFormatMode | Utility class containing constants.
Specifies how formatting is merged when importing content from another document.
|
JoinStyle | Utility class containing constants.
Line join style.
|
JsonSimpleValueParseMode | Utility class containing 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.
|
LayoutEntityType | Utility class containing constants.
Types of the layout entities.
|
LayoutFlow | Utility class containing constants.
Determines the flow of the text layout in a textbox.
|
LegendPosition | Utility class containing constants.
Specifies the possible positions for a chart legend.
|
LineNumberRestartMode | Utility class containing constants.
Determines when automatic line numbering restarts.
|
LineSpacingRule | Utility class containing constants.
Specifies line spacing values for a paragraph.
|
LineStyle | Utility class containing constants.
Specifies line style of a |
ListLevelAlignment | Utility class containing constants.
Specifies alignment for the list number or bullet.
|
ListTemplate | Utility class containing constants.
Specifies one of the predefined list formats available in Microsoft Word.
|
ListTrailingCharacter | Utility class containing constants.
Specifies the character that separates the list label from the text of the paragraph.
|
LoadFormat | Utility class containing constants.
Indicates the format of the document that is to be loaded.
|
MailMergeCheckErrors | Utility class containing constants.
Specifies how Microsoft Word will report errors detected during mail merge.
|
MailMergeCleanupOptions | Utility class containing constants.
Specifies options that determine what items are removed during mail merge.
|
MailMergeDataType | Utility class containing constants.
Specifies the type of an external mail merge data source.
|
MailMergeDestination | Utility class containing constants.
Specifies the possible results which may be generated when a mail merge is carried out on a document.
|
MailMergeMainDocumentType | Utility class containing constants.
Specifies the possible types for a mail merge source document.
|
MarkerSymbol | Utility class containing constants.
Specifies marker symbol style.
|
MarkupLevel | Utility class containing constants.
Specifies the level in the document tree where a particular |
MathObjectType | Utility class containing constants.
Specifies type of an Office Math object.
|
MeasurementUnits | Utility class containing constants.
Specifies the unit of measurement.
|
MergeFieldImageDimensionUnit | Utility class containing constants.
Specifies an unit of an image dimension (i.e. the width or the height) used across a mail merge process.
|
MetafileRenderingMode | Utility class containing constants.
Specifies how Aspose.Words should render WMF and EMF metafiles.
|
MsWordVersion | Utility class containing constants.
Allows Aspose.Wods to mimic MS Word version-specific application behavior.
|
MultiplePagesType | Utility class containing constants.
Specifies how document is printed out.
|
NodeChangingAction | Utility class containing constants.
Specifies the type of node change.
|
NodeType | Utility class containing constants.
Specifies the type of a Word document node.
|
NumberStyle | Utility class containing constants.
Specifies the number style for a list, footnotes and endnotes, page numbers.
|
NumeralFormat | Utility class containing constants.
Indicates the symbol set that is used to represent numbers
while rendering to fixed page formats.
|
OdsoDataSourceType | Utility class containing constants.
Specifies the type of the external data source to be connected to as part of the ODSO connection information.
|
OdsoFieldMappingType | Utility class containing constants.
Specifies the possible types used to indicate if a given mail merge field has been mapped to a column in the given external data source.
|
OdtSaveMeasureUnit | Utility class containing constants.
Specified units of measure to apply to measurable document content such as shape, widths and other during saving.
|
OfficeMathDisplayType | Utility class containing constants.
Specifies the display format type of the equation.
|
OfficeMathJustification | Utility class containing constants.
Specifies the justification of the equation.
|
OoxmlCompliance | Utility class containing constants.
Allows to specify which OOXML specification will be used when saving in the DOCX format.
|
Orientation | Utility class containing constants.
Specifies page orientation.
|
OutlineLevel | Utility class containing constants.
Specifies the outline level of a paragraph in the document.
|
PageBorderAppliesTo | Utility class containing constants.
Specifies which pages the page border is printed on.
|
PageBorderDistanceFrom | Utility class containing constants.
Specifies the positioning of the page border relative to the page margin.
|
PageLayoutEvent | Utility class containing constants.
A code of event raised during page layout model build and rendering.
Page layout model is built in two steps.
First, "conversion step", this is when page layout pulls document content and creates object graph.
Second, "reflow step", this is when structures are split, merged and arranged into pages.
Depending of the operation which triggered build, page layout model may or may not be further rendered into fixed page format.
For example, computing number of pages in the document or updating fields does not require rendering, whereas export to Pdf does. |
PageVerticalAlignment | Utility class containing constants.
Specifies vertical justification of text on each page.
|
PaperSize | Utility class containing constants.
Specifies paper size.
|
ParagraphAlignment | Utility class containing constants.
Specifies text alignment in a paragraph.
|
PdfCompliance | Utility class containing constants.
Specifies the PDF standards compliance level.
|
PdfCustomPropertiesExport | Utility class containing constants.
Specifies the way |
PdfDigitalSignatureHashAlgorithm | Utility class containing constants.
Specifies a digital hash algorithm used by a digital signature.
|
PdfEncryptionAlgorithm | Utility class containing constants.
Specifies the encryption algorithm to use for encrypting a PDF document.
|
PdfFontEmbeddingMode | Utility class containing constants.
Specifies how Aspose.Words should embed fonts.
|
PdfImageColorSpaceExportMode | Utility class containing constants.
Specifies how the color space will be selected for the images in PDF document.
|
PdfImageCompression | Utility class containing constants.
Specifies the type of compression applied to images in the PDF file.
|
PdfPageMode | Utility class containing constants.
Specifies how the PDF document should be displayed when opened in the PDF reader.
|
PdfPermissions | Utility class containing constants.
Specifies the operations that are allowed to a user on an encrypted PDF document.
|
PdfTextCompression | Utility class containing constants.
Specifies a type of compression applied to all content in the PDF file except images.
|
PdfZoomBehavior | Utility class containing constants.
Specifies the type of zoom applied to a PDF document when it is opened in a PDF viewer.
|
PreferredWidthType | Utility class containing constants.
Specifies the unit of measurement for the preferred width of a table or cell.
|
PropertyType | Utility class containing constants.
Specifies data type of a document property.
|
ProtectionType | Utility class containing constants.
Protection type for a document.
|
RelativeHorizontalPosition | Utility class containing constants.
Specifies to what the horizontal position of a shape or text frame is relative.
|
RelativeVerticalPosition | Utility class containing constants.
Specifies to what the vertical position of a shape or text frame is relative.
|
ReplaceAction | Utility class containing constants.
Allows the user to specify what happens to the current match during a replace operation.
|
ReportBuildOptions | Utility class containing constants.
Specifies options controlling behavior of |
ResourceLoadingAction | Utility class containing constants.
Specifies the mode of resource loading.
|
ResourceType | Utility class containing constants.
Type of loaded resource.
|
RevisionColor | Utility class containing constants.
Allows to specify color of document revisions.
|
RevisionsView | Utility class containing constants.
Allows to specify whether to work with the original or revised version of a document.
|
RevisionTextEffect | Utility class containing constants.
Allows to specify decoration effect for revisions of document text.
|
RevisionType | Utility class containing constants.
Specifies the type of change being tracked in |
SaveFormat | Utility class containing constants.
Indicates the format in which the document is saved.
|
SdtCalendarType | Utility class containing constants.
Specifies the possible types of calendars which can be used to specify |
SdtDateStorageFormat | Utility class containing constants.
Specifies how the date for a date SDT is stored/retrieved when the SDT is bound to an XML node in the document's data store.
|
SdtType | Utility class containing constants.
Specifies the type of a structured document tag (SDT) node.
|
SectionLayoutMode | Utility class containing constants.
Specifies the layout mode for a section allowing to define the document grid behavior.
|
SectionStart | Utility class containing constants.
The type of break at the beginning of the section.
|
ShapeLineStyle | Utility class containing constants.
Specifies the compound line style of a |
ShapeMarkupLanguage | Utility class containing constants.
Specifies Markup language used for the shape.
|
ShapeType | Utility class containing constants.
Specifies the type of shape in a Microsoft Word document.
|
ShowInBalloons | Utility class containing constants.
Specifies which revisions are rendered in balloons.
|
StoryType | Utility class containing constants.
Text of a Word document is stored in stories. StoryType identifies a story.
|
StyleIdentifier | Utility class containing constants.
Locale independent style identifier.
|
StyleType | Utility class containing constants.
Represents type of the style.
|
SvgTextOutputMode | Utility class containing constants. |
TabAlignment | Utility class containing constants.
Specifies the alignment/type of a tab stop.
|
TabLeader | Utility class containing constants.
Specifies the type of the leader line displayed under the tab character.
|
TableAlignment | Utility class containing constants.
Specifies alignment for an inline table.
|
TableContentAlignment | Utility class containing constants.
Allows to specify the alignment of the content of the table to be used when exporting into Markdown format.
|
TableStyleOptions | Utility class containing constants.
Specifies how table style is applied to a table.
|
TaskPaneDockState | Utility class containing constants.
Enumerates available locations of task pane object.
|
TextBoxAnchor | Utility class containing constants.
Specifies values used for shape text vertical alignment.
|
TextBoxWrapMode | Utility class containing constants.
Specifies how text wraps inside a shape.
|
TextDmlEffect | Utility class containing constants.
Dml text effect for text runs.
|
TextEffect | Utility class containing constants.
Animation effect for text runs.
|
TextFormFieldType | Utility class containing constants.
Specifies the type of a text form field.
|
TextOrientation | Utility class containing constants.
Specifies orientation of text on a page, in a table cell or a text frame.
|
TextPathAlignment | Utility class containing constants.
WordArt alignment.
|
TextureIndex | Utility class containing constants.
Specifies shading texture.
|
TextWrapping | Utility class containing constants.
Specifies how text is wrapped around the table.
|
TiffCompression | Utility class containing constants.
Specifies what type of compression to apply when saving page images into a TIFF file.
|
TxtExportHeadersFootersMode | Utility class containing constants.
Specifies the way headers and footers are exported to plain text format.
|
TxtLeadingSpacesOptions | Utility class containing constants.
Specifies available options for leading space handling during import from |
TxtTrailingSpacesOptions | Utility class containing constants.
Specifies available options for trailing spaces handling during import from |
Underline | Utility class containing constants.
Indicates type of the underline applied to a font.
|
UnicodeScript | Utility class containing constants. |
VbaModuleType | Utility class containing constants.
Specifies the type of a model in a VBA project.
|
VbaReferenceType | Utility class containing constants.
Allows to specify the type of a |
VerticalAlignment | Utility class containing constants.
Specifies vertical alignment of a floating shape, text frame or a floating table.
|
ViewType | Utility class containing constants.
Possible values for the view mode in Microsoft Word.
|
VisitorAction | Utility class containing constants.
Allows the visitor to control the enumeration of nodes.
|
WarningSource | Utility class containing constants.
Specifies the module that produces a warning during document loading or saving.
|
WarningType | Utility class containing constants.
Specifies the type of a warning that is issued by Aspose.Words during document loading or saving.
|
WatermarkLayout | Utility class containing constants.
Defines layout of the watermark relative to the watermark center.
|
WatermarkType | Utility class containing constants.
Specifies the watermark type.
|
WebExtensionBindingType | Utility class containing constants.
Enumerates available types of binding between a web extension and the data in the document.
|
WebExtensionStoreType | Utility class containing constants.
Enumerates available types of a web extension store.
|
WrapSide | Utility class containing constants.
Specifies what side(s) of the shape or picture the text wraps around.
|
WrapType | Utility class containing constants.
Specifies how text is wrapped around a shape or picture.
|
ZoomType | Utility class containing constants.
Possible values for how large or small the document appears on the screen in Microsoft Word.
|