|
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Aspose.Words</name>
- </assembly>
- <members>
- <member name="T:Aspose.Words.DocumentDirection">
- <summary>
- Allows to specify the direction to flow the text in a document.
- </summary>
- </member>
- <member name="F:Aspose.Words.DocumentDirection.LeftToRight">
- <summary>
- Left to right direction.
- </summary>
- </member>
- <member name="F:Aspose.Words.DocumentDirection.RightToLeft">
- <summary>
- Right to left direction.
- </summary>
- </member>
- <member name="F:Aspose.Words.DocumentDirection.Auto">
- <summary>
- Auto-detect direction.
- </summary>
- <remarks>
- When this option is selected and text contains characters belonging to RTL scripts,
- the document direction will be set automatically to RTL.
- </remarks>
- </member>
- <member name="T:Aspose.Words.DocumentReaderPluginLoadException">
- <summary>
- Thrown during document load, when the plugin required for reading the document format cannot be loaded.
- </summary>
- </member>
- <member name="T:Aspose.Words.IDocumentReaderPlugin">
- <summary>
- Defines an interface for external reader plugins that can read a file into a document.
- </summary>
- </member>
- <member name="M:Aspose.Words.IDocumentReaderPlugin.Read(System.IO.Stream,Aspose.Words.LoadOptions,Aspose.Words.Document)">
- <summary>
- Reads the data from the specified stream into the <see cref="T:Aspose.Words.Document" /> instance.
- </summary>
- <param name="src">The source stream to read the document from.</param>
- <param name="loadOptions">An additional load options to load the document.</param>
- <param name="document">The instance of the <see cref="T:Aspose.Words.Document" /> class to read the data to.
- If the instance contains some content, it will be overriden by the data from the source stream</param>
- </member>
- <member name="T:Aspose.Words.PdfLoadOptions">
- <summary>
- Allows to specify additional options when loading Pdf document into a <see cref="T:Aspose.Words.Document" /> object.
- </summary>
- </member>
- <member name="P:Aspose.Words.PdfLoadOptions.PageIndex">
- <summary>
- Gets or sets the 0-based index of the first page to read. Default is 0.
- </summary>
- </member>
- <member name="P:Aspose.Words.PdfLoadOptions.PageCount">
- <summary>
- Gets or sets the number of pages to read. Default is MaxValue which means all pages of the document will be read.
- </summary>
- </member>
- <member name="P:Aspose.Words.PdfLoadOptions.SkipPdfImages">
- <summary>
- Gets or sets the flag indicating whether images must be skipped while loading PDF document. Default is False.
- </summary>
- </member>
- <member name="T:Aspose.Words.RtfLoadOptions">
- <summary>
- Allows to specify additional options when loading <see cref="F:Aspose.Words.LoadFormat.Rtf" /> document into a <see cref="T:Aspose.Words.Document" /> object.
- </summary>
- </member>
- <member name="M:Aspose.Words.RtfLoadOptions.#ctor">
- <summary>
- Initializes a new instance of this class with default values.
- </summary>
- </member>
- <member name="M:Aspose.Words.RtfLoadOptions.#ctor(Aspose.Words.LoadOptions)">
- <summary>
- Initializes a new instance of this class with <see cref="T:Aspose.Words.LoadOptions" /> instance.
- </summary>
- </member>
- <member name="P:Aspose.Words.RtfLoadOptions.RecognizeUtf8Text">
- <summary>
- <para> When set to true, <see cref="T:Aspose.Charset.CharsetDetector" /> will try to detect UTF8 characters,
- they will be preserved during import.
- </para>
- Default value is false.
- </summary>
- </member>
- <member name="T:Aspose.Words.Watermark">
- <summary>
- Represents class to work with document watermark.
- </summary>
- <dev>
- FIX 4879. This class has been added to working with a watermark.
- </dev>
- </member>
- <member name="M:Aspose.Words.Watermark.SetText(System.String)">
- <summary>
- Adds Text watermark into the document.
- </summary>
- <param name="text">Text that is displayed as a watermark.</param>
- <remarks>
- The text length must be in the range from 1 to 200 inclusive.
- The text cannot be null or contain only whitespaces.
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Throws when the text length is out of range or the text contains only whitespaces.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Throws when the text is null.
- </exception>
- </member>
- <member name="M:Aspose.Words.Watermark.SetText(System.String,Aspose.Words.TextWatermarkOptions)">
- <summary>
- Adds Text watermark into the document.
- </summary>
- <param name="text">Text that is displayed as a watermark.</param>
- <param name="options">Defines additional options for the text watermark.</param>
- <remarks>
- The text length must be in the range from 1 to 200 inclusive.
- The text cannot be null or contain only whitespaces.
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Throws when the text length is out of range or the text contain only whitespaces.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- Throws when the text is null.
- </exception>
- <remarks>If <see cref="T:Aspose.Words.TextWatermarkOptions" /> is null, the watermark will be set with default options.</remarks>
- </member>
- <member name="M:Aspose.Words.Watermark.SetImage(System.Drawing.Image)">
- <summary>
- Adds Image watermark into the document.
- </summary>
- <param name="image">Image that is displayed as a watermark.</param>
- <exception cref="T:System.ArgumentNullException">
- Throws when the image is null.
- </exception>
- </member>
- <member name="M:Aspose.Words.Watermark.SetImage(System.Drawing.Image,Aspose.Words.ImageWatermarkOptions)">
- <summary>
- Adds Image watermark into the document.
- </summary>
- <param name="image">Image that is displayed as a watermark.</param>
- <param name="options">Defines additional options for the image watermark.</param>
- <exception cref="T:System.ArgumentNullException">
- Throws when the image is null.
- </exception>
- <remarks>If <see cref="T:Aspose.Words.ImageWatermarkOptions" /> is null, the watermark will be set with default options.</remarks>
- </member>
- <member name="M:Aspose.Words.Watermark.Remove">
- <summary>
- Removes the watermark.
- </summary>
- </member>
- <member name="P:Aspose.Words.Watermark.Type">
- <summary>
- Gets the watermark type.
- </summary>
- </member>
- <member name="T:Aspose.Words.WatermarkType">
- <summary>
- Specifies the watermark type.
- </summary>
- </member>
- <member name="F:Aspose.Words.WatermarkType.Text">
- <summary>
- Indicates that the text will be used as a watermark.
- <p>Such a watermark corresponds to a WordArt object.</p></summary>
- </member>
- <member name="F:Aspose.Words.WatermarkType.Image">
- <summary>
- Indicates that the image will be used as a watermark.
- <p>Such a watermark corresponds to a shape with image.</p></summary>
- </member>
- <member name="F:Aspose.Words.WatermarkType.None">
- <summary>
- Indicates watermark is no set.
- </summary>
- </member>
- <member name="T:Aspose.Words.ImageWatermarkOptions">
- <summary>
- Contains options that can be specified when adding a watermark with image.
- </summary>
- </member>
- <member name="P:Aspose.Words.ImageWatermarkOptions.Scale">
- <summary>
- Gets or sets the scale factor expressed as a fraction of the image. The default value is 0 - auto.
- </summary>
- <remarks>
- <p>Valid values range from 0 to 65.5 inclusive.</p>
- <p>Auto scale means that the watermark will be scaled to its max width and max height relative to
- the page margins.</p>
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Throws when argument was out of the range of valid values.
- </exception>
- </member>
- <member name="P:Aspose.Words.ImageWatermarkOptions.IsWashout">
- <summary>
- Gets or sets a boolean value which is responsible for washout effect of the watermark.
- The default value is True.
- </summary>
- </member>
- <member name="T:Aspose.Words.TextWatermarkOptions">
- <summary>
- Contains options that can be specified when adding a watermark with text.
- </summary>
- </member>
- <member name="P:Aspose.Words.TextWatermarkOptions.FontFamily">
- <summary>
- Gets or sets font family name. The default value is "Calibri".
- </summary>
- </member>
- <member name="P:Aspose.Words.TextWatermarkOptions.Color">
- <summary>
- Gets or sets font color. The default value is Color.Silver.
- </summary>
- </member>
- <member name="P:Aspose.Words.TextWatermarkOptions.FontSize">
- <summary>
- Gets or sets a font size. The default value is 0 - auto.
- </summary>
- <remarks>
- <p>Valid values range from 0 to 65.5 inclusive.</p>
- <p> Auto font size means that the watermark will be scaled to its max width and max height relative to
- the page margins.</p>
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Throws when argument was out of the range of valid values.
- </exception>
- </member>
- <member name="P:Aspose.Words.TextWatermarkOptions.IsSemitrasparent">
- <summary>
- Gets or sets a boolean value which is responsible for opacity of the watermark.
- The default value is True.
- </summary>
- </member>
- <member name="P:Aspose.Words.TextWatermarkOptions.Layout">
- <summary>
- Gets or sets layout of the watermark. The default value is <see cref="F:Aspose.Words.WatermarkLayout.Diagonal" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.WatermarkLayout">
- <summary>
- Defines layout of the watermark relative to the watermark center.
- </summary>
- </member>
- <member name="F:Aspose.Words.WatermarkLayout.Horizontal">
- <summary>
- Horizontal watermark layout. Corresponds to 0 degrees of rotation.
- </summary>
- </member>
- <member name="F:Aspose.Words.WatermarkLayout.Diagonal">
- <summary>
- Diagonal watermark layout. Corresponds to 315 degrees of rotation.
- </summary>
- </member>
- <member name="T:Aspose.Words.EditingLanguage">
- <summary>
- Specifies the editing language.
- </summary>
- <dev>
- https://msdn.microsoft.com/en-us/library/windows/desktop/dd318693(v=vs.85).aspx
- and also
- https://ss64.com/locale.html
- </dev>
- </member>
- <member name="T:Aspose.Words.LanguagePreferences">
- <summary>
- Allows to set up language preferences.
- </summary>
- <remarks>
- Implements 'Set the Office Language Preferences' dialog in Word.
- </remarks>
- </member>
- <member name="M:Aspose.Words.LanguagePreferences.AddEditingLanguage(Aspose.Words.EditingLanguage)">
- <summary>
- Adds additional editing language.
- </summary>
- </member>
- <member name="M:Aspose.Words.LanguagePreferences.AddEditingLanguages(Aspose.Words.EditingLanguage[])">
- <summary>
- Adds additional editing languages.
- </summary>
- </member>
- <member name="P:Aspose.Words.LanguagePreferences.DefaultEditingLanguage">
- <summary>
- <para>Gets or sets default editing language.</para>
- <para>The default value is <see cref="F:Aspose.Words.EditingLanguage.EnglishUS" />.</para>
- </summary>
- </member>
- <member name="T:Aspose.Words.ComparisonTargetType">
- <summary>
- Allows to specify base document which will be used during comparison. Default value is <see cref="F:Aspose.Words.ComparisonTargetType.Current" />.
- </summary>
- <remarks>
- Relates to Microsoft Word "Show changes in" option in "Compare Documents" dialog box.
- </remarks>
- </member>
- <member name="F:Aspose.Words.ComparisonTargetType.Current">
- <summary>
- This document is used as a base during comparison.
- </summary>
- </member>
- <member name="F:Aspose.Words.ComparisonTargetType.New">
- <summary>
- Other document is used as a base during comparison.
- </summary>
- </member>
- <member name="T:Aspose.Words.SignOptions">
- <summary>
- Allows to specify options for document signing.
- </summary>
- </member>
- <member name="P:Aspose.Words.SignOptions.Comments">
- <summary>
- Specifies comments on the digital signature.
- Default value is <b>empty string</b> (<see cref="F:System.String.Empty" />).
- </summary>
- </member>
- <member name="P:Aspose.Words.SignOptions.SignTime">
- <summary>
- The date of signing.
- Default value is <b>current time</b> (<see cref="P:System.DateTime.Now" />).
- </summary>
- </member>
- <member name="P:Aspose.Words.SignOptions.SignatureLineId">
- <summary>
- Signature line identifier.
- Default value is <b>Empty (all zeroes) Guid</b>.
- </summary>
- <remarks>
- When set, it associates <see cref="T:Aspose.Words.Drawing.SignatureLine" /> with corresponding <see cref="T:Aspose.Words.DigitalSignature" />.
- </remarks>
- </member>
- <member name="P:Aspose.Words.SignOptions.SignatureLineImage">
- <summary>
- The image that will be shown in associated <see cref="T:Aspose.Words.Drawing.SignatureLine" />.
- Default value is <c>null</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.SignOptions.DecryptionPassword">
- <summary>
- The password to decrypt source document.
- Default value is <b>empty string</b> (<see cref="F:System.String.Empty" />).
- </summary>
- <remarks>
- If OOXML document is encrypted, you should provide decryption password
- to decrypt source document before it will be signed.
- This is not required for documents in binary DOC format.
- </remarks>
- </member>
- <member name="P:Aspose.Words.SignOptions.ProviderId">
- <summary>
- Specifies the class ID of the signature provider.
- Default value is <b>Empty (all zeroes) Guid</b>.
- </summary>
- <remarks>
- <para>The cryptographic service provider (CSP) is an independent software module that actually performs
- cryptography algorithms for authentication, encoding, and encryption. MS Office reserves the value
- of {00000000-0000-0000-0000-000000000000} for its default signature provider.</para>
- <para>The GUID of the additionally installed provider should be obtained from the documentation shipped with the provider.</para>
- <para>In addition, all the installed cryptographic providers are enumerated in windows registry.
- It can be found in the following path: HKLM\SOFTWARE\Microsoft\Cryptography\Defaults\Provider.
- There is a key name "CP Service UUID" which corresponds to a GUID of signature provider.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.HtmlControlType">
- <summary>
- Type of document nodes that represent <input> and <select> elements imported from HTML.
- </summary>
- </member>
- <member name="T:Aspose.Words.TxtLeadingSpacesOptions">
- <summary>
- Specifies available options for leading space handling during import from <see cref="F:Aspose.Words.LoadFormat.Text" /> file.
- </summary>
- </member>
- <member name="T:Aspose.Words.TxtLoadOptions">
- <summary>
- Allows to specify additional options when loading <see cref="F:Aspose.Words.LoadFormat.Text" /> document into a <see cref="T:Aspose.Words.Document" /> object.
- </summary>
- </member>
- <member name="M:Aspose.Words.TxtLoadOptions.#ctor">
- <summary>
- Initializes a new instance of this class with default values.
- </summary>
- </member>
- <member name="M:Aspose.Words.TxtLoadOptions.#ctor(Aspose.Words.LoadOptions)">
- <summary>
- Creates a new instance of this class from a specified LoadOptions object.
- </summary>
- </member>
- <member name="P:Aspose.Words.TxtLoadOptions.DetectNumberingWithWhitespaces">
- <summary>
- Allows to specify how numbered list items are recognized when document is imported from plain text format.
- The default value is true.</summary>
- <remarks>
- <para> If this option is set to false, lists recognition algorithm detects list paragraphs, when list numbers ends with
- either dot, right bracket or bullet symbols (such as "•", "*", "-" or "o").</para>
- <para> If this option is set to true, whitespaces are also used as list number delimeters:
- list recognition algorithm for Arabic style numbering (1., 1.1.2.) uses both whitespaces and dot (".") symbols.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.TxtLoadOptions.TrailingSpacesOptions">
- <summary>
- Gets or sets preferred option of a trailing space handling.
- Default value is <see cref="F:Aspose.Words.TxtTrailingSpacesOptions.Trim" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.TxtLoadOptions.LeadingSpacesOptions">
- <summary>
- Gets or sets preferred option of a leading space handling.
- Default value is <see cref="F:Aspose.Words.TxtLeadingSpacesOptions.ConvertToIndent" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.TxtLoadOptions.DocumentDirection">
- <summary>
- Gets or sets a document direction.
- The default value is <see cref="F:Aspose.Words.DocumentDirection.LeftToRight" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.CleanupOptions">
- <summary>
- Allows to specify options for document cleaning.
- </summary>
- </member>
- <member name="P:Aspose.Words.CleanupOptions.UnusedStyles">
- <summary>
- Specifies whether unused styles should be removed from document.
- Default value is <b>true</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.CleanupOptions.UnusedLists">
- <summary>
- Specifies whether unused list and list definitions should be removed from document.
- Default value is <b>true</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.CleanupOptions.DuplicateStyle">
- <summary>
- Gets/sets a flag indicating whether duplicate styles should be removed from document.
- Default value is <b>false</b>.
- </summary>
- </member>
- <member name="T:Aspose.Words.TxtTrailingSpacesOptions">
- <summary>
- Specifies available options for trailing spaces handling during import from <see cref="F:Aspose.Words.LoadFormat.Text" /> file.
- </summary>
- </member>
- <member name="T:Aspose.Words.EndnotePosition">
- <summary>
- Defines the endnote position.
- </summary>
- <seealso cref="T:Aspose.Words.EndnoteOptions" />
- </member>
- <member name="F:Aspose.Words.EndnotePosition.EndOfSection">
- <summary>
- Endnotes are output at the end of the section.
- </summary>
- </member>
- <member name="F:Aspose.Words.EndnotePosition.EndOfDocument">
- <summary>
- Endnotes are output at the end of the document.
- </summary>
- </member>
- <member name="T:Aspose.Words.EndnoteOptions">
- <summary>
- Represents the endnote numbering options for a document or section.
- </summary>
- <seealso cref="P:Aspose.Words.Document.EndnoteOptions" />
- <seealso cref="P:Aspose.Words.PageSetup.EndnoteOptions" />
- </member>
- <member name="P:Aspose.Words.EndnoteOptions.Position">
- <summary>
- Specifies the endnotes position.
- </summary>
- </member>
- <member name="P:Aspose.Words.EndnoteOptions.NumberStyle">
- <summary>
- Specifies the number format for automatically numbered endnotes.
- </summary>
- <remarks>
- <para>Not all number styles are applicable for this property. For the list of applicable
- number styles see the Insert Footnote or Endnote dialog box in Microsoft Word. If you select
- a number style that is not applicable, Microsoft Word will revert to a default value.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.EndnoteOptions.StartNumber">
- <summary>
- Specifies the starting number or character for the first automatically numbered endnotes.
- </summary>
- <remarks>
- <para>This property has effect only when <see cref="P:Aspose.Words.EndnoteOptions.RestartRule" /> is set to
- <see cref="F:Aspose.Words.FootnoteNumberingRule.Continuous" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.EndnoteOptions.RestartRule">
- <summary>
- Determines when automatic numbering restarts.
- </summary>
- <remarks>
- <para>Not all values are applicable to endnotes.
- To ascertain which values are applicable see <see cref="T:Aspose.Words.FootnoteNumberingRule" />.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.MeasurementUnits">
- <summary>
- Specifies the unit of measurement.
- </summary>
- </member>
- <member name="F:Aspose.Words.MeasurementUnits.Inches">
- <summary>
- Inches.
- </summary>
- </member>
- <member name="F:Aspose.Words.MeasurementUnits.Centimeters">
- <summary>
- Centimeters.
- </summary>
- </member>
- <member name="F:Aspose.Words.MeasurementUnits.Millimeters">
- <summary>
- Millimeters.
- </summary>
- </member>
- <member name="F:Aspose.Words.MeasurementUnits.Points">
- <summary>
- Points.
- </summary>
- </member>
- <member name="F:Aspose.Words.MeasurementUnits.Picas">
- <summary>
- Picas (commonly used in traditional typewriter font spacing).
- </summary>
- </member>
- <member name="T:Aspose.Words.ConditionalStyleCollection">
- <summary>
- Represents a collection of <see cref="T:Aspose.Words.ConditionalStyle" /> objects.
- </summary>
- <remarks>
- It is not possible to add or remove items from this collection. It contains permanent set of items: one item for
- each value of the <see cref="T:Aspose.Words.ConditionalStyleType" /> enumeration type.
- </remarks>
- <dev>
- With using public properties of the class, it is possible to get only conditional styles that correspond to items
- of the <see cref="T:Aspose.Words.ConditionalStyleType" /> enumeration type. But a collection may contain also styles related
- to <see cref="F:Aspose.Words.TableStyleOverrideType.None" /> and <see cref="F:Aspose.Words.TableStyleOverrideType.WholeTable" /> values, use the
- this[TableStyleOverrideType] or <see cref="P:Aspose.Words.ConditionalStyleCollection.DefinedStyles" /> properties to get them.
- </dev>
- </member>
- <member name="M:Aspose.Words.ConditionalStyleCollection.ClearFormatting">
- <summary>
- Clears all conditional styles of the table style.
- </summary>
- </member>
- <member name="M:Aspose.Words.ConditionalStyleCollection.GetEnumerator">
- <summary>
- Returns an enumerator object that can be used to iterate over all conditional styles in the collection.
- </summary>
- <dev>
- Conditional styles related to <see cref="F:Aspose.Words.TableStyleOverrideType.None" /> and
- <see cref="F:Aspose.Words.TableStyleOverrideType.WholeTable" /> values are not included into the enumeration.
- </dev>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.Item(Aspose.Words.ConditionalStyleType)">
- <overloads>
- Retrieves a <see cref="T:Aspose.Words.ConditionalStyle" /> object.
- </overloads>
- <summary>
- Retrieves a <see cref="T:Aspose.Words.ConditionalStyle" /> object by conditional style type.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.Item(Aspose.Words.TableStyleOverrideType)">
- <summary>
- Retrieves a <see cref="T:Aspose.Words.ConditionalStyle" /> object by table style override type.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.Item(System.Int32)">
- <summary>
- Retrieves a <see cref="T:Aspose.Words.ConditionalStyle" /> object by index.
- </summary>
- <param name="index">Zero-based index of the conditional style to retrieve.</param>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.Count">
- <summary>
- Gets the number of conditional styles in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.FirstRow">
- <summary>
- Gets the first row style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.FirstColumn">
- <summary>
- Gets the first column style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.LastRow">
- <summary>
- Gets the last row style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.LastColumn">
- <summary>
- Gets the last column style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.OddRowBanding">
- <summary>
- Gets the odd row banding style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.OddColumnBanding">
- <summary>
- Gets the odd column banding style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.EvenRowBanding">
- <summary>
- Gets the even row banding style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.EvenColumnBanding">
- <summary>
- Gets the even column banding style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.TopLeftCell">
- <summary>
- Gets the top left cell style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.TopRightCell">
- <summary>
- Gets the top right cell style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.BottomLeftCell">
- <summary>
- Gets the bottom left cell style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyleCollection.BottomRightCell">
- <summary>
- Gets the bottom right cell style.
- </summary>
- </member>
- <member name="T:Aspose.Words.ConditionalStyleType">
- <summary>
- Represents possible table areas to which conditional formatting may be defined in a table style.
- </summary>
- </member>
- <member name="F:Aspose.Words.ConditionalStyleType.FirstRow">
- <summary>
- Specifies formatting of the first row of a table.
- </summary>
- </member>
- <member name="F:Aspose.Words.ConditionalStyleType.FirstColumn">
- <summary>
- Specifies formatting of the first column of a table.
- </summary>
- </member>
- <member name="F:Aspose.Words.ConditionalStyleType.LastRow">
- <summary>
- Specifies formatting of the last row of a table.
- </summary>
- </member>
- <member name="F:Aspose.Words.ConditionalStyleType.LastColumn">
- <summary>
- Specifies formatting of the last column of a table.
- </summary>
- </member>
- <member name="F:Aspose.Words.ConditionalStyleType.OddRowBanding">
- <summary>
- Specifies formatting of odd-numbered row stripe.
- </summary>
- </member>
- <member name="F:Aspose.Words.ConditionalStyleType.OddColumnBanding">
- <summary>
- Specifies formatting of odd-numbered column stripe.
- </summary>
- </member>
- <member name="F:Aspose.Words.ConditionalStyleType.EvenRowBanding">
- <summary>
- Specifies formatting of even-numbered row stripe.
- </summary>
- </member>
- <member name="F:Aspose.Words.ConditionalStyleType.EvenColumnBanding">
- <summary>
- Specifies formatting of even-numbered column stripe.
- </summary>
- </member>
- <member name="F:Aspose.Words.ConditionalStyleType.TopLeftCell">
- <summary>
- Specifies formatting of the top left cell of a table.
- </summary>
- </member>
- <member name="F:Aspose.Words.ConditionalStyleType.TopRightCell">
- <summary>
- Specifies formatting of the top right cell of a table.
- </summary>
- </member>
- <member name="F:Aspose.Words.ConditionalStyleType.BottomLeftCell">
- <summary>
- Specifies formatting of the bottom left cell of a table.
- </summary>
- </member>
- <member name="F:Aspose.Words.ConditionalStyleType.BottomRightCell">
- <summary>
- Specifies formatting of the bottom right cell of a table.
- </summary>
- </member>
- <member name="T:Aspose.Words.TextDmlEffect">
- <summary>
- Dml text effect for text runs.
- </summary>
- </member>
- <member name="F:Aspose.Words.TextDmlEffect.Glow">
- <summary>
- Glow effect, in which a color blurred outline is added outside the edges of the object.
- </summary>
- </member>
- <member name="F:Aspose.Words.TextDmlEffect.Fill">
- <summary>
- Fill overlay effect.
- </summary>
- </member>
- <member name="F:Aspose.Words.TextDmlEffect.Shadow">
- <summary>
- Shadow effect.
- </summary>
- </member>
- <member name="F:Aspose.Words.TextDmlEffect.Outline">
- <summary>
- Outline effect.
- </summary>
- </member>
- <member name="F:Aspose.Words.TextDmlEffect.Effect3D">
- <summary>
- 3D effect.
- </summary>
- </member>
- <member name="F:Aspose.Words.TextDmlEffect.Reflection">
- <summary>
- Reflection effect.
- </summary>
- </member>
- <member name="T:Aspose.Words.CommentCollection">
- <summary>
- Provides typed access to a collection of <see cref="T:Aspose.Words.Comment" /> nodes.
- </summary>
- </member>
- <member name="P:Aspose.Words.CommentCollection.Item(System.Int32)">
- <summary>
- Retrieves a <b>Comment</b> at the given index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the collection.</param>
- </member>
- <member name="T:Aspose.Words.License">
- <summary>
- Provides methods to license the component.
- </summary>
- </member>
- <member name="M:Aspose.Words.License.#ctor">
- <summary>
- Initializes a new instance of this class.
- </summary>
- </member>
- <member name="M:Aspose.Words.License.SetLicense(System.String)">
- <summary>
- Licenses the component.
- </summary>
- <remarks>
- <p>Tries to find the license in the following locations:</p>
- <p>1. Explicit path.</p>
- <p>2. The folder that contains the Aspose component assembly.</p>
- <p>3. The folder that contains the client's calling assembly.</p>
- <p>4. The folder that contains the entry (startup) assembly.</p>
- <p>5. An embedded resource in the client's calling assembly.</p>
- <p>
- <b>Note:</b>On the .NET Compact Framework, tries to find the license only in these locations:</p>
- <p>1. Explicit path.</p>
- <p>2. An embedded resource in the client's calling assembly.</p>
- </remarks>
- <param name="licenseName">Can be a full or short file name or name of an embedded resource.
- Use an empty string to switch to evaluation mode.</param>
- </member>
- <member name="M:Aspose.Words.License.SetLicense(System.IO.Stream)">
- <summary>
- Licenses the component.
- </summary>
- <param name="stream">A stream that contains the license.</param>
- <remarks>
- <p>Use this method to load a license from a stream.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Metered">
- <summary>
- Provides methods to set metered key.
- </summary>
- <example>
- In this example, an attempt will be made to set metered public and private key
-
- <code>
- [C#]
-
- Metered matered = new Metered();
- matered.SetMeteredKey("PublicKey", "PrivateKey");
-
-
- [Visual Basic]
-
- Dim matered As Metered = New Metered
- matered.SetMeteredKey("PublicKey", "PrivateKey")
- </code></example>
- </member>
- <member name="M:Aspose.Words.Metered.#ctor">
- <summary>
- Initializes a new instance of this class.
- </summary>
- </member>
- <member name="M:Aspose.Words.Metered.SetMeteredKey(System.String,System.String)">
- <summary>
- Sets metered public and private key.
- If you purchase metered license, when start application, this API should be called, normally, this is enough.
- However, if always fail to upload consumption data and exceed 24 hours, the license will be set to evaluation status,
- to avoid such case, you should regularly check the license status, if it is evaluation status, call this API again.
- </summary>
- <param name="publicKey">public key</param>
- <param name="privateKey">private key</param>
- </member>
- <member name="M:Aspose.Words.Metered.GetConsumptionQuantity">
- <summary>
- Gets consumption file size
- </summary>
- <returns>consumption quantity</returns>
- </member>
- <member name="M:Aspose.Words.Metered.GetConsumptionCredit">
- <summary>
- Gets consumption credit
- </summary>
- <returns>consumption quantity</returns>
- </member>
- <member name="T:Aspose.Words.CompareOptions">
- <summary>
- Allows to choose advanced options for document comparison operation.
- </summary>
- </member>
- <member name="P:Aspose.Words.CompareOptions.IgnoreCaseChanges">
- <summary>
- True indicates that documents comparison is case insensitive.
- By default comparison is case sensitive.
- </summary>
- </member>
- <member name="P:Aspose.Words.CompareOptions.IgnoreTables">
- <summary>
- Specifies whether to compare the differences in data contained in tables.
- By default tables are not ignored.
- </summary>
- </member>
- <member name="P:Aspose.Words.CompareOptions.IgnoreFields">
- <summary>
- Specifies whether to compare differences in fields.
- By default fields are not ignored.
- </summary>
- </member>
- <member name="P:Aspose.Words.CompareOptions.IgnoreFootnotes">
- <summary>
- Specifies whether to compare differences in footnotes and endnotes.
- By default footnotes are not ignored.
- </summary>
- </member>
- <member name="P:Aspose.Words.CompareOptions.IgnoreComments">
- <summary>
- Specifies whether to compare differences in comments.
- By default comments are not ignored.
- </summary>
- </member>
- <member name="P:Aspose.Words.CompareOptions.IgnoreTextboxes">
- <summary>
- Specifies whether to compare differences in the data contained within text boxes.
- By default textboxes are not ignored.
- </summary>
- </member>
- <member name="P:Aspose.Words.CompareOptions.IgnoreFormatting">
- <summary>
- True indicates that formatting is ignored.
- By default document formatting is not ignored.
- </summary>
- </member>
- <member name="P:Aspose.Words.CompareOptions.IgnoreHeadersAndFooters">
- <summary>
- True indicates that headers and footers content is ignored.
- By default headers and footers are not ignored.
- </summary>
- </member>
- <member name="P:Aspose.Words.CompareOptions.Target">
- <summary>
- Specifies which document shall be used as a target during comparison.
- </summary>
- </member>
- <member name="P:Aspose.Words.CompareOptions.Granularity">
- <summary>
- Specifies whether changes are tracked by character or by word.
- Default value is <see cref="F:Aspose.Words.Granularity.WordLevel" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.CompareOptions.IgnoreDmlUniqueId">
- <summary>
- Specifies whether to ignore difference in DrawingML unique Id.
- Default value is <b>false</b>.
- </summary>
- </member>
- <member name="T:Aspose.Words.Granularity">
- <summary>
- Specifies the granularity of changes to track when comparing two documents.
- </summary>
- </member>
- <member name="T:Aspose.Words.CertificateHolder">
- <summary>
- Represents a holder of <b>X509Certificate2</b> instance.
- </summary>
- <remarks>
- <p>
- <b>CertificateHolder</b> can be created by static factory methods only.
- It contains an instance of <b>X509Certificate2</b> which is used to introduce private, public keys and certificate chains into the system.
- This class is applied in <see cref="T:Aspose.Words.DigitalSignatureUtil" /> and <see cref="T:Aspose.Words.Saving.PdfDigitalSignatureDetails" /> instead of obsolete methods with
- <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> as parameters.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.CertificateHolder.Create(System.Byte[],System.Security.SecureString)">
- <summary>
- Creates CertificateHolder object using byte array of PKCS12 store and its password.
- </summary>
- <param name="certBytes">A byte array that contains data from an X.509 certificate.</param>
- <param name="password">The password required to access the X.509 certificate data.</param>
- <returns>An instance of CertificateHolder</returns>
- <exception cref="T:Org.BouncyCastle.Security.InvalidParameterException">Thrown if <b>certBytes</b> is null</exception>
- <exception cref="T:Org.BouncyCastle.Security.InvalidParameterException">Thrown if <b>password</b> is null</exception>
- <exception cref="T:System.Security.SecurityException">Thrown if PKCS12 store contains no aliases</exception>
- <exception cref="T:System.IO.IOException">Thrown if there is wrong password or corrupted file.</exception>
- </member>
- <member name="M:Aspose.Words.CertificateHolder.Create(System.Byte[],System.String)">
- <summary>
- Creates CertificateHolder object using byte array of PKCS12 store and its password.
- </summary>
- <param name="certBytes">A byte array that contains data from an X.509 certificate.</param>
- <param name="password">The password required to access the X.509 certificate data.</param>
- <returns>An instance of CertificateHolder</returns>
- <exception cref="T:Org.BouncyCastle.Security.InvalidParameterException">Thrown if <b>certBytes</b> is null</exception>
- <exception cref="T:Org.BouncyCastle.Security.InvalidParameterException">Thrown if <b>password</b> is null</exception>
- <exception cref="T:System.Security.SecurityException">Thrown if PKCS12 store contains no aliases</exception>
- <exception cref="T:System.IO.IOException">Thrown if there is wrong password or corrupted file.</exception>
- </member>
- <member name="M:Aspose.Words.CertificateHolder.Create(System.String,System.String)">
- <summary>
- Creates CertificateHolder object using path to PKCS12 store and its password.
- </summary>
- <param name="fileName">The name of a certificate file.</param>
- <param name="password">The password required to access the X.509 certificate data.</param>
- <returns>An instance of CertificateHolder</returns>
- <exception cref="T:Org.BouncyCastle.Security.InvalidParameterException">Thrown if <b>fileName</b> is null</exception>
- <exception cref="T:Org.BouncyCastle.Security.InvalidParameterException">Thrown if <b>password</b> is null</exception>
- <exception cref="T:System.Security.SecurityException">Thrown if PKCS12 store contains no aliases</exception>
- <exception cref="T:System.IO.IOException">Thrown if there is wrong password or corrupted file.</exception>
- </member>
- <member name="M:Aspose.Words.CertificateHolder.Create(System.String,System.String,System.String)">
- <summary>
- Creates CertificateHolder object using path to PKCS12 store, its password and the alias by using which private key and certificate will be found.
- </summary>
- <param name="fileName">The name of a certificate file.</param>
- <param name="password">The password required to access the X.509 certificate data.</param>
- <param name="alias">The associated alias for a certificate and its private key</param>
- <returns>An instance of CertificateHolder</returns>
- <exception cref="T:Org.BouncyCastle.Security.InvalidParameterException">Thrown if <b>fileName</b> is null</exception>
- <exception cref="T:Org.BouncyCastle.Security.InvalidParameterException">Thrown if <b>password</b> is null</exception>
- <exception cref="T:System.Security.SecurityException">Thrown if PKCS12 store contains no aliases</exception>
- <exception cref="T:System.IO.IOException">Thrown if there is wrong password or corrupted file.</exception>
- <exception cref="T:System.Security.SecurityException">Thrown if there is no private key with the given alias</exception>
- </member>
- <member name="P:Aspose.Words.CertificateHolder.Certificate">
- <summary>
- Returns the instance of <b>X509Certificate2</b> which holds private, public keys and certificate chain.
- </summary>
- <returns>
- <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> instance</returns>
- </member>
- <member name="T:Aspose.Words.HtmlLoadOptions">
- <summary>
- Allows to specify additional options when loading HTML document into a <see cref="T:Aspose.Words.Document" /> object.
- </summary>
- </member>
- <member name="M:Aspose.Words.HtmlLoadOptions.#ctor">
- <summary>
- Initializes a new instance of this class with default values.
- </summary>
- </member>
- <member name="M:Aspose.Words.HtmlLoadOptions.#ctor(System.String)">
- <summary>
- A shortcut to initialize a new instance of this class with the specified password to load an encrypted document.
- </summary>
- <param name="password">The password to open an encrypted document. Can be null or empty string.</param>
- </member>
- <member name="M:Aspose.Words.HtmlLoadOptions.#ctor(Aspose.Words.LoadFormat,System.String,System.String)">
- <summary>
- A shortcut to initialize a new instance of this class with properties set to the specified values.
- </summary>
- <param name="loadFormat">The format of the document to be loaded.</param>
- <param name="password">The password to open an encrypted document. Can be null or empty string.</param>
- <param name="baseUri">The string that will be used to resolve relative URIs to absolute. Can be null or empty string.</param>
- </member>
- <member name="M:Aspose.Words.HtmlLoadOptions.#ctor(Aspose.Words.HtmlLoadOptions)">
- <summary>
- Copy constructor.
- </summary>
- </member>
- <member name="M:Aspose.Words.HtmlLoadOptions.#ctor(Aspose.Words.LoadOptions)">
- <summary>
- Initializes a new instance of this class with <see cref="T:Aspose.Words.LoadOptions" /> instance.
- </summary>
- </member>
- <member name="P:Aspose.Words.HtmlLoadOptions.SupportVml">
- <summary>
- Gets or sets a value indicating whether to support VML images.
- </summary>
- </member>
- <member name="P:Aspose.Words.HtmlLoadOptions.WebRequestTimeout">
- <summary>
- The number of milliseconds to wait before the web request times out. The default value is 100000 milliseconds
- (100 seconds).
- </summary>
- <remarks>
- The number of milliseconds that Aspose.Words waits for a response, when loading external resources (images, style
- sheets) linked in HTML and MHTML documents.
- </remarks>
- </member>
- <member name="P:Aspose.Words.HtmlLoadOptions.PreferredControlType">
- <summary>
- Gets or sets preffered type of document nodes that will represent imported <input> and <select> elements.
- Default value is <see cref="F:Aspose.Words.HtmlControlType.FormField" />.
- </summary>
- <remarks>
- Please note that setting this property does not guarantee that all imported controls will be of the specified type.
- If an HTML control is not representable with document nodes of the preferred type, Aspose.Words will use
- a compatible <see cref="T:Aspose.Words.HtmlControlType" /> for that control.
- </remarks>
- </member>
- <member name="T:Aspose.Words.CalendarType">
- <summary>
- Specifies the type of a calendar.
- </summary>
- </member>
- <member name="F:Aspose.Words.CalendarType.Gregorian">
- <summary>
- The Gregorian calendar.
- </summary>
- </member>
- <member name="F:Aspose.Words.CalendarType.Hijri">
- <summary>
- The Hijri Lunar calendar.
- </summary>
- </member>
- <member name="F:Aspose.Words.CalendarType.Hebrew">
- <summary>
- The Hebrew Lunar calendar.
- </summary>
- </member>
- <member name="F:Aspose.Words.CalendarType.SakaEra">
- <summary>
- The Saka Era calendar.
- </summary>
- </member>
- <member name="F:Aspose.Words.CalendarType.UmAlQura">
- <summary>
- The Um-al-Qura calendar.
- </summary>
- </member>
- <member name="T:Aspose.Words.InternableComplexAttr">
- <summary>
- Base class for internable complex attribute.
- Internable complex attribute should notify parent collection when going to be changed.
- </summary>
- </member>
- <member name="T:Aspose.Words.FrameFormat">
- <summary>
- Represents frame related formatting for a paragraph.
- </summary>
- <remarks>
- <p>This object is always created. If a paragraph is a frame, then all properties will contain respective values, otherwise
- all properties are set to their defaults.</p>
- <p>Use <see cref="P:Aspose.Words.FrameFormat.IsFrame" /> to check whether paragraph is a frame.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.FrameFormat.HeightRule">
- <summary>
- Gets the rule for determining the height of the specified frame.
- </summary>
- </member>
- <member name="P:Aspose.Words.FrameFormat.Height">
- <summary>
- Gets the height of the specified frame.
- </summary>
- </member>
- <member name="P:Aspose.Words.FrameFormat.HorizontalDistanceFromText">
- <summary>
- Gets horizontal distance between a frame and the surrounding text, in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.FrameFormat.HorizontalPosition">
- <summary>
- Gets horizontal distance between the edge of the frame and the item specified by the <see cref="P:Aspose.Words.FrameFormat.RelativeHorizontalPosition" /> property.
- </summary>
- </member>
- <member name="P:Aspose.Words.FrameFormat.RelativeHorizontalPosition">
- <summary>
- Gets the relative horizontal position of a frame.
- </summary>
- </member>
- <member name="P:Aspose.Words.FrameFormat.RelativeVerticalPosition">
- <summary>
- Gets the relative vertical position of a frame.
- </summary>
- </member>
- <member name="P:Aspose.Words.FrameFormat.VerticalDistanceFromText">
- <summary>
- Specifies vertical distance (in points) between a frame and the surrounding text.
- </summary>
- </member>
- <member name="P:Aspose.Words.FrameFormat.VerticalPosition">
- <summary>
- Gets vertical distance between the edge of the frame and the item specified by the <see cref="P:Aspose.Words.FrameFormat.RelativeVerticalPosition" /> property.
- </summary>
- </member>
- <member name="P:Aspose.Words.FrameFormat.Width">
- <summary>
- Gets the width of the specified frame, in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.FrameFormat.VerticalAlignment">
- <summary>
- Gets vertical alignment of the specified frame.
- </summary>
- </member>
- <member name="P:Aspose.Words.FrameFormat.HorizontalAlignment">
- <summary>
- Gets horizontal alignment of the specified frame.
- </summary>
- </member>
- <member name="P:Aspose.Words.FrameFormat.IsFrame">
- <summary>
- Returns true if the paragraph is a frame.
- </summary>
- </member>
- <member name="T:Aspose.Words.VbaModule">
- <summary>
- Provides access to VBA project module.
- </summary>
- </member>
- <member name="M:Aspose.Words.VbaModule.#ctor">
- <summary>
- Creates an empty module.
- </summary>
- </member>
- <member name="M:Aspose.Words.VbaModule.#ctor(System.String)">
- <summary>
- Creates an empty procedural module.
- </summary>
- </member>
- <member name="M:Aspose.Words.VbaModule.Clone">
- <summary>
- Performs a copy of the <see cref="T:Aspose.Words.VbaModule" />.
- </summary>
- <returns>The cloned VbaModule.</returns>
- </member>
- <member name="P:Aspose.Words.VbaModule.Name">
- <summary>
- Gets or sets VBA project module name.
- </summary>
- </member>
- <member name="P:Aspose.Words.VbaModule.SourceCode">
- <summary>
- Gets or sets VBA project module source code.
- </summary>
- </member>
- <member name="P:Aspose.Words.VbaModule.Type">
- <summary>
- Specifies whether the module is a procedural module, document module, class module, or designer module.
- </summary>
- </member>
- <member name="T:Aspose.Words.VbaModuleCollection">
- <summary>
- Represents a collection of <see cref="T:Aspose.Words.VbaModule" /> objects.
- </summary>
- </member>
- <member name="M:Aspose.Words.VbaModuleCollection.Add(Aspose.Words.VbaModule)">
- <summary>
- Adds a module to the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.VbaModuleCollection.Remove(Aspose.Words.VbaModule)">
- <summary>
- Removes the specified module from the collection.
- </summary>
- <param name="module">The module to remove.</param>
- </member>
- <member name="P:Aspose.Words.VbaModuleCollection.Item(System.Int32)">
- <summary>
- Retrieves a <see cref="T:Aspose.Words.VbaModule" /> object by index.
- </summary>
- <param name="index">Zero-based index of the module to retrieve.</param>
- </member>
- <member name="P:Aspose.Words.VbaModuleCollection.Item(System.String)">
- <summary>
- Retrieves a <see cref="T:Aspose.Words.VbaModule" /> object by name, or Null if not found.
- </summary>
- </member>
- <member name="P:Aspose.Words.VbaModuleCollection.Count">
- <summary>
- Returns the number of VBA modules in the collection.
- </summary>
- </member>
- <member name="T:Aspose.Words.VbaModuleType">
- <summary>
- Specifies the type of a model in a VBA project.
- </summary>
- </member>
- <member name="F:Aspose.Words.VbaModuleType.DocumentModule">
- <summary>
- A type of VBA project item that specifies a module for embedded macros and programmatic access operations
- that are associated with a document.
- </summary>
- </member>
- <member name="F:Aspose.Words.VbaModuleType.ProceduralModule">
- <summary>
- A collection of subroutines and functions.
- </summary>
- </member>
- <member name="F:Aspose.Words.VbaModuleType.ClassModule">
- <summary>
- A module that contains the definition for a new object. Each instance of a class creates a new object,
- and procedures that are defined in the module become properties and methods of the object.
- </summary>
- </member>
- <member name="F:Aspose.Words.VbaModuleType.DesignerModule">
- <summary>
- A VBA module that extends the methods and properties of an ActiveX control that has been registered with the project.
- </summary>
- </member>
- <member name="T:Aspose.Words.VbaProject">
- <summary>
- Provides access to VBA project information.
- A VBA project inside the document is defined as a collection of VBA modules.
- </summary>
- </member>
- <member name="M:Aspose.Words.VbaProject.#ctor">
- <summary>
- Creates a blank VbaProject.
- </summary>
- </member>
- <member name="M:Aspose.Words.VbaProject.#ctor(Aspose.Ss.MemoryStorage)">
- <summary>
- Creates a VbaProject from the <paramref name="vbaStorage" />.
- </summary>
- </member>
- <member name="M:Aspose.Words.VbaProject.Clone">
- <summary>
- Performs a copy of the <see cref="T:Aspose.Words.VbaProject" />.
- </summary>
- <returns>The cloned VbaProject.</returns>
- </member>
- <member name="P:Aspose.Words.VbaProject.Name">
- <summary>
- Gets or sets VBA project name.
- </summary>
- </member>
- <member name="P:Aspose.Words.VbaProject.Modules">
- <summary>
- Returns collection of VBA project modules.
- </summary>
- </member>
- <member name="P:Aspose.Words.VbaProject.CodePage">
- <summary>
- Returns the VBA project’s code page.
- </summary>
- </member>
- <member name="P:Aspose.Words.VbaProject.IsSigned">
- <summary>
- Shows whether the VbaProject is signed or not.
- </summary>
- </member>
- <member name="P:Aspose.Words.VbaProject.References">
- <summary>
- Gets a collection of VBA project references.
- </summary>
- </member>
- <member name="T:Aspose.Words.VbaReference">
- <summary>
- Implements a reference to an Automation type library or VBA project.
- </summary>
- </member>
- <member name="P:Aspose.Words.VbaReference.Type">
- <summary>
- Gets <see cref="T:Aspose.Words.VbaReferenceType" /> object that indicates the type of reference that a VbaReference object represents.
- </summary>
- </member>
- <member name="P:Aspose.Words.VbaReference.LibId">
- <summary>
- Gets a string value containing the identifier of an Automation type library.
- </summary>
- <remarks>
- Depending on reference type, the value of this property can be:
- <list type="bullet"><item>a LibidReference specified at 2.1.1.8 LibidReference of [MS-OVBA]:
- https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-ovba/3737ef6e-d819-4186-a5f2-6e258ddf66a5</item><item>a ProjectReference specified at 2.1.1.12 ProjectReference of [MS-OVBA]:
- https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-ovba/9a45ac1a-f1ff-4ebd-958e-537701aa8131</item></list></remarks>
- </member>
- <member name="T:Aspose.Words.VbaReferenceCollection">
- <summary>
- Represents a collection of <see cref="T:Aspose.Words.VbaReference" /> objects.
- </summary>
- </member>
- <member name="M:Aspose.Words.VbaReferenceCollection.Remove(Aspose.Words.VbaReference)">
- <summary>
- Removes the first occurrence of a specified VbaReference item from the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.VbaReferenceCollection.RemoveAt(System.Int32)">
- <summary>
- Removes the VbaReference element at the specified index of the the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.VbaReferenceCollection.Count">
- <summary>
- Returns the number of VBA references in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.VbaReferenceCollection.Item(System.Int32)">
- <summary>
- Gets <see cref="T:Aspose.Words.VbaReference" /> object at the specified index.
- </summary>
- <param name="index">The zero-based index of the reference to get.</param>
- </member>
- <member name="T:Aspose.Words.VbaReferenceType">
- <summary>
- Allows to specify the type of a <see cref="T:Aspose.Words.VbaReference" /> object.
- </summary>
- </member>
- <member name="F:Aspose.Words.VbaReferenceType.Registered">
- <summary>
- Specifies an Automation type library reference type.
- </summary>
- <remarks>
- This type corresponds to 2.3.4.2.2.5 REFERENCEREGISTERED Record of [MS-OVBA]:
- https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-ovba/6c39388e-96f5-4b93-b90a-ae625a063fcf
- </remarks>
- </member>
- <member name="F:Aspose.Words.VbaReferenceType.Project">
- <summary>
- Specified an external VBA project reference type.
- </summary>
- <remarks>
- This type corresponds to 2.3.4.2.2.6 REFERENCEPROJECT Record of [MS-OVBA]:
- https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-ovba/08280eb0-d628-495c-867f-5985ed020142
- </remarks>
- </member>
- <member name="F:Aspose.Words.VbaReferenceType.Original">
- <summary>
- Specifies an original Automation type library reference type.
- </summary>
- <remarks>
- This type corresponds to 2.3.4.2.2.4 REFERENCEORIGINAL Record of [MS-OVBA]:
- https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-ovba/3ba66994-8c7a-4634-b2da-f9331ace6686
- </remarks>
- </member>
- <member name="F:Aspose.Words.VbaReferenceType.Control">
- <summary>
- Specifies a twiddled type library reference type.
- </summary>
- <remarks>
- This type corresponds to 2.3.4.2.2.3 REFERENCECONTROL Record of [MS-OVBA]:
- https://docs.microsoft.com/en-us/openspecs/office_file_formats/ms-ovba/d64485fa-8562-4726-9c5e-11e8f01a81c0
- </remarks>
- </member>
- <member name="T:Aspose.Words.FindReplaceDirection">
- <summary>
- Specifies direction for replace operations.
- </summary>
- </member>
- <member name="F:Aspose.Words.FindReplaceDirection.Forward">
- <summary>
- Matched items are replaced from first to last.
- </summary>
- </member>
- <member name="F:Aspose.Words.FindReplaceDirection.Backward">
- <summary>
- Matched items are replaced from last back to first.
- </summary>
- </member>
- <member name="T:Aspose.Words.RevisionGroup">
- <summary>
- Represents a group of sequential <see cref="T:Aspose.Words.Revision" /> objects.
- </summary>
- </member>
- <member name="P:Aspose.Words.RevisionGroup.Text">
- <summary>
- Returns inserted/deleted/moved text or description of format change.
- </summary>
- </member>
- <member name="P:Aspose.Words.RevisionGroup.Author">
- <summary>
- Gets the author of this revision group.
- </summary>
- </member>
- <member name="P:Aspose.Words.RevisionGroup.RevisionType">
- <summary>
- Gets the type of revisions included in this group.
- </summary>
- </member>
- <member name="T:Aspose.Words.RevisionGroupCollection">
- <summary>
- A collection of <see cref="T:Aspose.Words.RevisionGroup" /> objects that represent revision groups in the document.
- </summary>
- <remarks>
- <para>You do not create instances of this class directly. Use the <see cref="P:Aspose.Words.RevisionCollection.Groups" />
- property to get revision groups present in a document.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.RevisionGroupCollection.GetEnumerator">
- <summary>
- Returns an enumerator object.
- </summary>
- </member>
- <member name="P:Aspose.Words.RevisionGroupCollection.Item(System.Int32)">
- <summary>
- Returns a revision group at the specified index.
- </summary>
- </member>
- <member name="P:Aspose.Words.RevisionGroupCollection.Count">
- <summary>
- Returns the number of revision groups in the collection.
- </summary>
- </member>
- <member name="T:Aspose.Words.PlainTextDocument">
- <summary>
- Allows to extract plain-text representation of the document's content.
- </summary>
- </member>
- <member name="M:Aspose.Words.PlainTextDocument.#ctor(System.String)">
- <summary>
- Creates a plain text document from a file. Automatically detects the file format.
- </summary>
- <param name="fileName">Name of the file to extract the text from.</param>
- <exception cref="T:Aspose.Words.UnsupportedFileFormatException">The document format is not recognized or not supported.</exception>
- <exception cref="T:Aspose.Words.FileCorruptedException">The document appears to be corrupted and cannot be loaded.</exception>
- <exception cref="T:System.Exception">There is a problem with the document and it should be reported to Aspose.Words developers.</exception>
- <exception cref="T:System.IO.IOException">There is an input/output exception.</exception>
- <exception cref="T:Aspose.Words.IncorrectPasswordException">The document is encrypted and requires a password to open, but you supplied an incorrect password.</exception>
- <exception cref="T:System.ArgumentException">The name of the file cannot be null or empty string.</exception>
- </member>
- <member name="M:Aspose.Words.PlainTextDocument.#ctor(System.String,Aspose.Words.LoadOptions)">
- <summary>
- Creates a plain text document from a file. Allows to specify additional options such as an encryption password.
- </summary>
- <remarks>
- </remarks>
- <param name="fileName">Name of the file to extract the text from.</param>
- <param name="loadOptions">Additional options to use when loading a document. Can be null.</param>
- <exception cref="T:Aspose.Words.UnsupportedFileFormatException">The document format is not recognized or not supported.</exception>
- <exception cref="T:Aspose.Words.FileCorruptedException">The document appears to be corrupted and cannot be loaded.</exception>
- <exception cref="T:System.Exception">There is a problem with the document and it should be reported to Aspose.Words developers.</exception>
- <exception cref="T:System.IO.IOException">There is an input/output exception.</exception>
- <exception cref="T:Aspose.Words.IncorrectPasswordException">The document is encrypted and requires a password to open, but you supplied an incorrect password.</exception>
- <exception cref="T:System.ArgumentException">The name of the file cannot be null or empty string.</exception>
- </member>
- <member name="M:Aspose.Words.PlainTextDocument.#ctor(System.IO.Stream)">
- <summary>
- Creates a plain text document from a stream. Automatically detects the file format.
- </summary>
- <remarks>
- <p>
- The document must be stored at the beginning of the stream. The stream must support random positioning.</p>
- </remarks>
- <param name="stream">The stream where to extract the text from.</param>
- <exception cref="T:Aspose.Words.UnsupportedFileFormatException">The document format is not recognized or not supported.</exception>
- <exception cref="T:Aspose.Words.FileCorruptedException">The document appears to be corrupted and cannot be loaded.</exception>
- <exception cref="T:System.Exception">There is a problem with the document and it should be reported to Aspose.Words developers.</exception>
- <exception cref="T:System.IO.IOException">There is an input/output exception.</exception>
- <exception cref="T:Aspose.Words.IncorrectPasswordException">The document is encrypted and requires a password to open, but you supplied an incorrect password.</exception>
- <exception cref="T:System.ArgumentNullException">The stream cannot be null.</exception>
- <exception cref="T:System.NotSupportedException">The stream does not support reading or seeking.</exception>
- <exception cref="T:System.ObjectDisposedException">The stream is a disposed object.</exception>
- </member>
- <member name="M:Aspose.Words.PlainTextDocument.#ctor(System.IO.Stream,Aspose.Words.LoadOptions)">
- <summary>
- Creates a plain text document from a stream. Allows to specify additional options such as an encryption password.
- </summary>
- <remarks>
- <p>
- The document must be stored at the beginning of the stream. The stream must support random positioning.</p>
- </remarks>
- <param name="stream">The stream where to extract the text from.</param>
- <param name="loadOptions">Additional options to use when loading a document. Can be null.</param>
- <exception cref="T:Aspose.Words.UnsupportedFileFormatException">The document format is not recognized or not supported.</exception>
- <exception cref="T:Aspose.Words.FileCorruptedException">The document appears to be corrupted and cannot be loaded.</exception>
- <exception cref="T:System.Exception">There is a problem with the document and it should be reported to Aspose.Words developers.</exception>
- <exception cref="T:System.IO.IOException">There is an input/output exception.</exception>
- <exception cref="T:Aspose.Words.IncorrectPasswordException">The document is encrypted and requires a password to open, but you supplied an incorrect password.</exception>
- <exception cref="T:System.ArgumentNullException">The stream cannot be null.</exception>
- <exception cref="T:System.NotSupportedException">The stream does not support reading or seeking.</exception>
- <exception cref="T:System.ObjectDisposedException">The stream is a disposed object.</exception>
- </member>
- <member name="P:Aspose.Words.PlainTextDocument.Text">
- <summary>
- Gets textual content of the document concatenated as a string.
- </summary>
- </member>
- <member name="P:Aspose.Words.PlainTextDocument.BuiltInDocumentProperties">
- <summary>
- Gets <see cref="P:Aspose.Words.PlainTextDocument.BuiltInDocumentProperties" /> of the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.PlainTextDocument.CustomDocumentProperties">
- <summary>
- Gets <see cref="P:Aspose.Words.PlainTextDocument.CustomDocumentProperties" /> of the document.
- </summary>
- </member>
- <member name="T:Aspose.Words.SignatureLineOptions">
- <summary>
- Allows to specify options for signature line being inserted. Used in <see cref="T:Aspose.Words.DocumentBuilder" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.SignatureLineOptions.Signer">
- <summary>
- Gets or sets suggested signer of the signature line.
- Default value for this property is <b>empty string</b> (<see cref="F:System.String.Empty" />).
- </summary>
- </member>
- <member name="P:Aspose.Words.SignatureLineOptions.SignerTitle">
- <summary>
- Gets or sets suggested signer's title.
- Default value for this property is <b>empty string</b> (<see cref="F:System.String.Empty" />).
- </summary>
- </member>
- <member name="P:Aspose.Words.SignatureLineOptions.Email">
- <summary>
- Gets or sets suggested signer's e-mail address.
- Default value for this property is <b>empty string</b> (<see cref="F:System.String.Empty" />).
- </summary>
- </member>
- <member name="P:Aspose.Words.SignatureLineOptions.DefaultInstructions">
- <summary>
- Gets or sets a value indicating that default instructions is shown in the Sign dialog.
- Default value for this property is <b>true</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.SignatureLineOptions.Instructions">
- <summary>
- Gets or sets instructions to the signer that are displayed on signing the signature line.
- Default value for this property is <b>empty string</b> (<see cref="F:System.String.Empty" />).
- </summary>
- </member>
- <member name="P:Aspose.Words.SignatureLineOptions.AllowComments">
- <summary>
- Gets or sets a value indicating that the signer can add comments in the Sign dialog.
- Default value for this property is <b>false</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.SignatureLineOptions.ShowDate">
- <summary>
- Gets or sets a value indicating that sign date is shown in the signature line.
- Default value for this property is <b>true</b>.
- </summary>
- </member>
- <member name="T:Aspose.Words.RevisionsView">
- <summary>
- Allows to specify whether to work with the original or revised version of a document.
- </summary>
- </member>
- <member name="F:Aspose.Words.RevisionsView.Original">
- <summary>
- Specifies original version of a document.
- </summary>
- </member>
- <member name="F:Aspose.Words.RevisionsView.Final">
- <summary>
- Specifies revised version of a document.
- </summary>
- </member>
- <member name="T:Aspose.Words.ImportFormatOptions">
- <summary>
- Allows to specify various import options to format output.
- </summary>
- <dev>
- The most of these options can be found under the advanced options menu in Word, 'cut, copy and paste' section.
- But some of them, such as <see cref="P:Aspose.Words.ImportFormatOptions.KeepSourceNumbering" /> have no analogue in Word.
- </dev>
- </member>
- <member name="P:Aspose.Words.ImportFormatOptions.SmartStyleBehavior">
- <summary>
- Gets or sets a boolean value that specifies how styles will be imported
- when they have equal names in source and destination documents.
- The default value is <c>false</c>.
- </summary>
- <remarks>
- <para>When this option is <b>enabled</b>, the source style will be expanded into a direct attributes inside a
- destination document, if <see cref="F:Aspose.Words.ImportFormatMode.KeepSourceFormatting" /> importing mode is used.</para>
- <para>When this option is <b>disabled</b>, the source style will be expanded only if it is numbered. Existing
- destination attributes will not be overridden, including lists.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.ImportFormatOptions.KeepSourceNumbering">
- <summary>
- Gets or sets a boolean value that specifies how the numbering will be imported when it clashes in source and
- destination documents.
- The default value is <c>false</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.ImportFormatOptions.IgnoreTextBoxes">
- <summary>
- Gets or sets a boolean value that specifies that source formatting of textboxes content ignored
- if <see cref="F:Aspose.Words.ImportFormatMode.KeepSourceFormatting" /> mode is used.
- The default value is <c>true</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.ImportFormatOptions.IgnoreHeaderFooter">
- <summary>
- Gets or sets a boolean value that specifies that source formatting of headers/footers content ignored
- if <see cref="F:Aspose.Words.ImportFormatMode.KeepSourceFormatting" /> mode is used.
- The default value is <c>true</c>.
- </summary>
- </member>
- <member name="T:Aspose.Words.IHyphenationCallback">
- <summary>
- Implemented by classes which can register hyphenation dictionaries.
- </summary>
- </member>
- <member name="M:Aspose.Words.IHyphenationCallback.RequestDictionary(System.String)">
- <summary>
- Notifies application that hyphenation dictionary for the specified language wasn't found and may need to be registered.<para />
- Implementation should find a dictionary and register it using <see cref="M:Aspose.Words.Hyphenation.RegisterDictionary(System.String,System.IO.Stream)" /> methods.<para />
- If dictionary is unavailable for the specified language implementation can opt out of further calls for the same language
- using <see cref="M:Aspose.Words.Hyphenation.RegisterDictionary(System.String,System.String)" /> with null value.
- </summary>
- <param name="language">A language name, e.g. "en-US". See .NET documentation for "culture name" and RFC 4646 for details.</param>
- <remarks>Exceptions thrown by this method will abort execution of page layout process.</remarks>
- </member>
- <member name="T:Aspose.Words.Hyphenation">
- <summary>
- Provides methods for working with hyphenation dictionaries. These dictionaries prescribe where words of a specific language can be hyphenated.
- </summary>
- </member>
- <member name="M:Aspose.Words.Hyphenation.RegisterDictionary(System.String,System.IO.Stream)">
- <summary>
- Registers and loads a hyphenation dictionary for the specified language from a stream. Throws if dictionary cannot be read or has invalid format.
- </summary>
- <param name="language">A language name, e.g. "en-US". See .NET documentation for "culture name" and RFC 4646 for details.</param>
- <param name="stream">A stream for the dictionary file in OpenOffice format.</param>
- </member>
- <member name="M:Aspose.Words.Hyphenation.RegisterDictionary(System.String,System.String)">
- <summary>
- Registers and loads a hyphenation dictionary for the specified language from file. Throws if dictionary cannot be read or has invalid format.<para />
- This method can also be used to register Null dictionary to prevent <see cref="P:Aspose.Words.Hyphenation.Callback" /> from being called repeatedly for the same language.
- </summary>
- <param name="language">A language name, e.g. "en-US". See .NET documentation for "culture name" and RFC 4646 for details.</param>
- <param name="fileName">A path to the dictionary file in Open Office format.<para />
- If this parameter is null or empty string then registered is Null dictionary and callback is not called anymore for this language.<para />
- To enable callback again use <see cref="M:Aspose.Words.Hyphenation.UnregisterDictionary(System.String)" /> method.</param>
- </member>
- <member name="M:Aspose.Words.Hyphenation.UnregisterDictionary(System.String)">
- <summary>
- Unregisters a hyphenation dictionary for the specified language.<para />
- This is different from registering Null dictionary. Unregistering a dictionary enables callback for the specified language.
- </summary>
- <param name="language">A language name, e.g. "en-US". See .NET documentation for "culture name" and RFC 4646 for details.<para />
- If null or empty string then all dictionaries are unregistered.</param>
- </member>
- <member name="M:Aspose.Words.Hyphenation.IsDictionaryRegistered(System.String)">
- <summary>
- Returns False if for the specified language there is no dictionary registered or if registered is Null dictionary, True otherwise.
- </summary>
- </member>
- <member name="P:Aspose.Words.Hyphenation.Callback">
- <summary>
- Gets or sets callback interface used to request dictionaries when page layout of the document is built.
- This allows delay loading of dictionaries which may be useful when processing documents in many languages.
- </summary>
- </member>
- <member name="P:Aspose.Words.Hyphenation.WarningCallback">
- <summary>
- Called during a load hyphenation patterns, when an issue is detected that might result in formatting fidelity loss.
- </summary>
- </member>
- <member name="T:Aspose.Words.InterruptionToken">
- <summary>
- This class is obsolete. Use <see cref="T:Aspose.Words.Layout.IPageLayoutCallback" /> instead.
-
- Provides method to manually interrupt Aspose.Words while page layout model is built.
- </summary>
- </member>
- <member name="M:Aspose.Words.InterruptionToken.Interrupt">
- <summary>
- Requests Aspose.Words to abandon the current task.
- </summary>
- <remarks>
- Throws a <see cref="T:System.Threading.ThreadInterruptedException" /> on processing the interrupt request.
- </remarks>
- </member>
- <member name="M:Aspose.Words.InterruptionToken.BindToCurrentThread">
- <summary>
- Associates the current thread with this <see cref="T:Aspose.Words.InterruptionToken" /> instance.
- </summary>
- <remarks>
- Use this method before calling <see cref="M:Aspose.Words.InterruptionToken.Interrupt" /></remarks>
- </member>
- <member name="T:Aspose.Words.DigitalSignatureUtil">
- <summary>
- Provides methods for signing document.
- </summary>
- <remarks>
- <para>Since digital signature works with file content rather than Document Object Model these methods are put into a separate class.</para>
- <para>Supported formats are <see cref="F:Aspose.Words.LoadFormat.Doc" /> and <see cref="F:Aspose.Words.LoadFormat.Docx" />.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DigitalSignatureUtil.Sign(System.IO.Stream,System.IO.Stream,Aspose.Words.CertificateHolder,Aspose.Words.SignOptions)">
- <summary>
- Signs source document using given <see cref="T:Aspose.Words.CertificateHolder" /> and <see cref="T:Aspose.Words.SignOptions" />
- with digital signature and writes signed document to destination stream.
- <p>Document should be either <see cref="F:Aspose.Words.LoadFormat.Doc" /> or <see cref="F:Aspose.Words.LoadFormat.Docx" />.</p><p><b>Output will be written to the start of stream and stream size will be updated with content length.</b></p></summary>
- <param name="srcStream">The stream which contains the document to sign.</param>
- <param name="dstStream">The stream that signed document will be written to.</param>
- <param name="certHolder">
- <see cref="T:Aspose.Words.CertificateHolder" /> object with certificate that used to sign file.
- The certificate in holder MUST contain private keys and have the X509KeyStorageFlags.Exportable flag set.</param>
- <param name="signOptions">
- <see cref="T:Aspose.Words.SignOptions" /> object with various signing options.</param>
- </member>
- <member name="M:Aspose.Words.DigitalSignatureUtil.Sign(System.String,System.String,Aspose.Words.CertificateHolder,Aspose.Words.SignOptions)">
- <summary>
- Signs source document using given <see cref="T:Aspose.Words.CertificateHolder" /> and <see cref="T:Aspose.Words.SignOptions" />
- with digital signature and writes signed document to destination file.
- <p>Document should be either <see cref="F:Aspose.Words.LoadFormat.Doc" /> or <see cref="F:Aspose.Words.LoadFormat.Docx" />.</p></summary>
- <param name="srcFileName">The file name of the document to sign.</param>
- <param name="dstFileName">The file name of the signed document output.</param>
- <param name="certHolder">
- <see cref="T:Aspose.Words.CertificateHolder" /> object with certificate that used to sign file.
- The certificate in holder MUST contain private keys and have the X509KeyStorageFlags.Exportable flag set.</param>
- <param name="signOptions">
- <see cref="T:Aspose.Words.SignOptions" /> object with various signing options.</param>
- </member>
- <member name="M:Aspose.Words.DigitalSignatureUtil.Sign(System.IO.Stream,System.IO.Stream,Aspose.Words.CertificateHolder)">
- <summary>
- Signs source document using given <see cref="T:Aspose.Words.CertificateHolder" /> with digital signature
- and writes signed document to destination stream.
- <p>Document should be either <see cref="F:Aspose.Words.LoadFormat.Doc" /> or <see cref="F:Aspose.Words.LoadFormat.Docx" />.</p><p><b>Output will be written to the start of stream and stream size will be updated with content length.</b></p></summary>
- <param name="srcStream">The stream which contains the document to sign.</param>
- <param name="dstStream">The stream that signed document will be written to.</param>
- <param name="certHolder">
- <see cref="T:Aspose.Words.CertificateHolder" /> object with certificate that used to sign file.
- The certificate in holder MUST contain private keys and have the X509KeyStorageFlags.Exportable flag set.</param>
- </member>
- <member name="M:Aspose.Words.DigitalSignatureUtil.Sign(System.String,System.String,Aspose.Words.CertificateHolder)">
- <summary>
- Signs source document using given <see cref="T:Aspose.Words.CertificateHolder" /> with digital signature
- and writes signed document to destination file.
- <p>Document should be either <see cref="F:Aspose.Words.LoadFormat.Doc" /> or <see cref="F:Aspose.Words.LoadFormat.Docx" />.</p></summary>
- <param name="srcFileName">The file name of the document to sign.</param>
- <param name="dstFileName">The file name of the signed document output.</param>
- <param name="certHolder">
- <see cref="T:Aspose.Words.CertificateHolder" /> object with certificate that used to sign file.
- The certificate in holder MUST contain private keys and have the X509KeyStorageFlags.Exportable flag set.</param>
- </member>
- <member name="M:Aspose.Words.DigitalSignatureUtil.RemoveAllSignatures(System.String,System.String)">
- <summary>
- Removes all digital signatures from source file and writes unsigned file to destination file.
- </summary>
- </member>
- <member name="M:Aspose.Words.DigitalSignatureUtil.RemoveAllSignatures(System.IO.Stream,System.IO.Stream)">
- <summary>
- Removes all digital signatures from document in source stream and writes unsigned document to destination stream.
- <p><b>Output will be written to the start of stream and stream size will be updated with content length.</b></p></summary>
- </member>
- <member name="M:Aspose.Words.DigitalSignatureUtil.LoadSignatures(System.String)">
- <summary>
- Loads digital signatures from document.
- </summary>
- <param name="fileName">Path to the document.</param>
- <returns>Collection of digital signatures. Returns empty collection if file is not signed.</returns>
- </member>
- <member name="M:Aspose.Words.DigitalSignatureUtil.LoadSignatures(System.IO.Stream)">
- <summary>
- Loads digital signatures from document using stream.
- </summary>
- <param name="stream">Stream with the document.</param>
- <returns>Collection of digital signatures. Returns empty collection if file is not signed.</returns>
- </member>
- <member name="T:Aspose.Words.EditorType">
- <summary>
- 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.
- </summary>
- </member>
- <member name="F:Aspose.Words.EditorType.Unspecified">
- <summary>
- Means that editor type is not specified.
- </summary>
- </member>
- <member name="F:Aspose.Words.EditorType.Administrators">
- <summary>
- Specifies that users associated with the Administrators group shall be allowed to edit editable ranges using
- this editing type when document protection is enabled.
- </summary>
- </member>
- <member name="F:Aspose.Words.EditorType.Contributors">
- <summary>
- Specifies that users associated with the Contributors group shall be allowed to edit editable ranges using
- this editing type when document protection is enabled.
- </summary>
- </member>
- <member name="F:Aspose.Words.EditorType.Current">
- <summary>
- Specifies that users associated with the Current group shall be allowed to edit editable ranges using this
- editing type when document protection is enabled.
- </summary>
- </member>
- <member name="F:Aspose.Words.EditorType.Editors">
- <summary>
- Specifies that users associated with the Editors group shall be allowed to edit editable ranges using this
- editing type when document protection is enabled.
- </summary>
- </member>
- <member name="F:Aspose.Words.EditorType.Everyone">
- <summary>
- Specifies that all users that open the document shall be allowed to edit editable ranges using this editing
- type when document protection is enabled.
- </summary>
- </member>
- <member name="F:Aspose.Words.EditorType.None">
- <summary>
- Specifies that none of the users that open the document shall be allowed to edit editable ranges
- using this editing type when document protection is enabled.
- </summary>
- </member>
- <member name="F:Aspose.Words.EditorType.Owners">
- <summary>
- Specifies that users associated with the Owners group shall be allowed to edit editable ranges using this
- editing type when document protection is enabled.
- </summary>
- </member>
- <member name="F:Aspose.Words.EditorType.Default">
- <summary>
- Same as <see cref="F:Aspose.Words.EditorType.Unspecified" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.EditableRange">
- <summary>
- Represents a single editable range.
- </summary>
- <remarks>
- <p>
- <see cref="T:Aspose.Words.EditableRange" /> is a "facade" object that encapsulates two nodes <see cref="P:Aspose.Words.EditableRange.EditableRangeStart" />
- and <see cref="P:Aspose.Words.EditableRange.EditableRangeEnd" /> in a document tree and allows to work with an editable range as a single object.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.EditableRange.Remove">
- <summary>
- Removes the editable range from the document. Does not remove content inside the editable range.
- </summary>
- </member>
- <member name="P:Aspose.Words.EditableRange.Id">
- <summary>
- Gets the editable range identifier.
- </summary>
- <remarks>
- <para>The region must be demarcated using the <see cref="P:Aspose.Words.EditableRange.EditableRangeStart" /> and <see cref="P:Aspose.Words.EditableRange.EditableRangeEnd" /></para>
- <para>Editable range identifiers are supposed to be unique across a document and Aspose.Words automatically
- maintains editable range identifiers when loading, saving and combining documents.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.EditableRange.SingleUser">
- <summary>
- Returns or sets the single user for editable range.
- </summary>
- <remarks>
- <p>This editor can be stored in one of the following forms:</p>
- <p>DOMAIN\Username - for users whose access shall be authenticated using the current user's domain credentials.</p>
- <p>user@domain.com - for users whose access shall be authenticated using the user's e-mail address as credentials.</p>
- <p>user - for users whose access shall be authenticated using the current user's machine credentials.</p>
- <p>Single user and editor group cannot be set simultaneously for the specific editable range,
- if the one is set, the other will be clear.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.EditableRange.EditorGroup">
- <summary>
- Returns or sets an alias (or editing group) which shall be used to determine if the current user
- shall be allowed to edit this editable range.
- </summary>
- <remarks>
- <p>Single user and editor group cannot be set simultaneously for the specific editable range,
- if the one is set, the other will be clear.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.EditableRange.EditableRangeStart">
- <summary>
- Gets the node that represents the start of the editable range.
- </summary>
- </member>
- <member name="P:Aspose.Words.EditableRange.EditableRangeEnd">
- <summary>
- Gets the node that represents the end of the editable range.
- </summary>
- </member>
- <member name="T:Aspose.Words.EditableRangeEnd">
- <summary>
- Represents an end of an editable range in a Word document.
- </summary>
- <remarks>
- <p>A complete editable range in a Word document consists of a <see cref="P:Aspose.Words.EditableRangeEnd.EditableRangeStart" />
- and a matching <see cref="T:Aspose.Words.EditableRangeEnd" /> with the same Id.</p>
- <p>
- <see cref="P:Aspose.Words.EditableRangeEnd.EditableRangeStart" /> and <see cref="T:Aspose.Words.EditableRangeEnd" /> are just markers inside a document
- that specify where the editable range starts and ends.</p>
- <p>Use the <see cref="T:Aspose.Words.EditableRange" /> class as a "facade" to work with an editable range
- as a single object.</p>
- <note>Currently editable ranges are supported only at the inline-level, that is inside <see cref="T:Aspose.Words.Paragraph" />,
- but editable range start and editable range end can be in different paragraphs.</note>
- </remarks>
- </member>
- <member name="M:Aspose.Words.EditableRangeEnd.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitEditableRangeEnd(Aspose.Words.EditableRangeEnd)" />.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the node.</param>
- <returns>False if the visitor requested the enumeration to stop.</returns>
- </member>
- <member name="P:Aspose.Words.EditableRangeEnd.EditableRangeStart">
- <summary>
- Corresponding EditableRangeStart, received by ID.
- </summary>
- </member>
- <member name="P:Aspose.Words.EditableRangeEnd.Id">
- <summary>
- Specifies the identifier of the editable range.
- </summary>
- </member>
- <member name="P:Aspose.Words.EditableRangeEnd.NodeType">
- <summary>
- Returns <see cref="F:Aspose.Words.NodeType.EditableRangeEnd" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.EditableRangeStart">
- <summary>
- Represents a start of an editable range in a Word document.
- </summary>
- <remarks>
- <p>A complete editable range in a Word document consists of a <see cref="T:Aspose.Words.EditableRangeStart" />
- and a matching <see cref="T:Aspose.Words.EditableRangeEnd" /> with the same Id.</p>
- <p>
- <see cref="T:Aspose.Words.EditableRangeStart" /> and <see cref="T:Aspose.Words.EditableRangeEnd" /> are just markers inside a document
- that specify where the editable range starts and ends.</p>
- <p>Use the <see cref="P:Aspose.Words.EditableRangeStart.EditableRange" /> class as a "facade" to work with an editable range
- as a single object.</p>
- <note>Currently editable ranges are supported only at the inline-level, that is inside <see cref="T:Aspose.Words.Paragraph" />,
- but editable range start and editable range end can be in different paragraphs.</note>
- </remarks>
- </member>
- <member name="M:Aspose.Words.EditableRangeStart.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitEditableRangeStart(Aspose.Words.EditableRangeStart)" />.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the node.</param>
- <returns>False if the visitor requested the enumeration to stop.</returns>
- </member>
- <member name="P:Aspose.Words.EditableRangeStart.Id">
- <summary>
- Specifies the identifier of the editable range.
- </summary>
- </member>
- <member name="P:Aspose.Words.EditableRangeStart.EditableRange">
- <summary>
- Gets the facade object that encapsulates this editable range start and end.
- </summary>
- </member>
- <member name="P:Aspose.Words.EditableRangeStart.NodeType">
- <summary>
- Returns <see cref="F:Aspose.Words.NodeType.EditableRangeStart" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.SubDocument">
- <summary>
- Represents a <b>SubDocument</b> - which is a reference to an externally stored document.
- </summary>
- <remarks>
- <para>In this version of Aspose.Words, <see cref="T:Aspose.Words.SubDocument" /> nodes do not provide public methods
- and properties to create or modify a subdocument. In this version you are not able to instantiate
- SubDocument nodes or modify existing except deleting them.</para>
- <p>
- <see cref="T:Aspose.Words.SubDocument" /> can only be a child of <see cref="T:Aspose.Words.Paragraph" />.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.SubDocument.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- </member>
- <member name="P:Aspose.Words.SubDocument.NodeType">
- <summary>
- Returns <b>NodeType.SubDocument</b></summary>
- </member>
- <member name="T:Aspose.Words.BuildVersionInfo">
- <summary>
- Provides information about the current product name and version.
- </summary>
- </member>
- <member name="P:Aspose.Words.BuildVersionInfo.Product">
- <summary>
- Gets the full name of the product.
- </summary>
- </member>
- <member name="P:Aspose.Words.BuildVersionInfo.Version">
- <summary>
- Gets the product version.
- </summary>
- <remarks>
- <para>The product version is in the "Major.Minor.Hotfix.0" format.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Revision">
- <summary>
- Represents a revision (tracked change) in a document node or style.
- Use <see cref="P:Aspose.Words.Revision.RevisionType" /> to check the type of this revision.
- </summary>
- </member>
- <member name="M:Aspose.Words.Revision.Accept">
- <summary>
- Accepts this revision.
- </summary>
- </member>
- <member name="M:Aspose.Words.Revision.Reject">
- <summary>
- Reject this revision.
- </summary>
- </member>
- <member name="P:Aspose.Words.Revision.Author">
- <summary>
- Gets or sets the author of this revision. Can not be empty string or null.
- </summary>
- </member>
- <member name="P:Aspose.Words.Revision.DateTime">
- <summary>
- Gets or sets the date/time of this revision.
- </summary>
- </member>
- <member name="P:Aspose.Words.Revision.RevisionType">
- <summary>
- Gets the type of this revision.
- </summary>
- </member>
- <member name="P:Aspose.Words.Revision.ParentNode">
- <summary>
- Gets the immediate parent node (owner) of this revision.
- This property will work for any revision type other than <see cref="F:Aspose.Words.RevisionType.StyleDefinitionChange" />.
- </summary>
- <remarks>
- If this revision relates to change of Style formatting, use <see cref="P:Aspose.Words.Revision.ParentStyle" /> instead.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Revision.ParentStyle">
- <summary>
- Gets the immediate parent style (owner) of this revision.
- This property will work for only for the <see cref="F:Aspose.Words.RevisionType.StyleDefinitionChange" /> revision type.
- </summary>
- <remarks>
- If this revision relates to changes on document nodes, use <see cref="P:Aspose.Words.Revision.ParentNode" /> instead.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Revision.Group">
- <summary>
- Gets the revision group. Returns null if the revision does not belong to any group.
- </summary>
- <remarks>
- Revision has no group if revision type is RevisionType.StyleDefinitionChange or
- if the revision is not longer exist in document context (accepted/rejected).
- </remarks>
- </member>
- <member name="T:Aspose.Words.RevisionCollection">
- <summary>
- A collection of <see cref="T:Aspose.Words.Revision" /> objects that represent revisions in the document.
- </summary>
- <remarks>
- <para>You do not create instances of this class directly. Use the <see cref="P:Aspose.Words.Document.Revisions" /> property to get revisions present in a document.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.RevisionCollection.AcceptAll">
- <summary>
- Accepts all revisions in this collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.RevisionCollection.RejectAll">
- <summary>
- Rejects all revisions in this collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.RevisionCollection.GetEnumerator">
- <summary>
- Returns an enumerator object.
- </summary>
- </member>
- <member name="P:Aspose.Words.RevisionCollection.Count">
- <summary>
- Returns the number of revisions in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.RevisionCollection.Item(System.Int32)">
- <summary>
- Returns a Revision at the specified index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the collection.</param>
- </member>
- <member name="P:Aspose.Words.RevisionCollection.Groups">
- <summary>
- Collection of revision groups.
- </summary>
- </member>
- <member name="T:Aspose.Words.RevisionType">
- <summary>
- Specifies the type of change being tracked in <see cref="T:Aspose.Words.Revision" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.RevisionType.Insertion">
- <summary>
- New content was inserted in the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.RevisionType.Deletion">
- <summary>
- Content was removed from the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.RevisionType.FormatChange">
- <summary>
- Change of formatting was applied to the parent node.
- </summary>
- </member>
- <member name="F:Aspose.Words.RevisionType.StyleDefinitionChange">
- <summary>
- Change of formatting was applied to the parent style.
- </summary>
- </member>
- <member name="F:Aspose.Words.RevisionType.Moving">
- <summary>
- Content was moved in the document.
- </summary>
- </member>
- <member name="T:Aspose.Words.FileFormatInfo">
- <summary>
- Contains data returned by <see cref="T:Aspose.Words.FileFormatUtil" /> document format detection methods.
- </summary>
- <remarks>
- <para>You do not create instances of this class directly. Objects of this class are returned by
- <see cref="M:Aspose.Words.FileFormatUtil.DetectFileFormat(System.IO.Stream)" /> methods.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.FileFormatInfo.LoadFormat">
- <summary>
- Gets the detected document format.
- </summary>
- <remarks>
- <para>When an OOXML document is encrypted, it is not possible to ascertained whether it is
- an Excel, Word or PowerPoint document without decrypting it first so for an encrypted OOXML
- document this property will always return <see cref="F:Aspose.Words.LoadFormat.Docx" />.</para>
- <seealso cref="P:Aspose.Words.FileFormatInfo.IsEncrypted" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.FileFormatInfo.IsEncrypted">
- <summary>
- Returns true if the document is encrypted and requires a password to open.
- </summary>
- <remarks>
- <para>This property exists to help you sort documents that are encrypted from those that are not.
- If you attempt to load an encrypted document using Aspose.Words without supplying a password an
- exception will be thrown. You can use this property to detect whether a document requires a password
- and take some action before loading a document, for example, prompt the user for a password. </para>
- <seealso cref="P:Aspose.Words.FileFormatInfo.LoadFormat" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.FileFormatInfo.HasDigitalSignature">
- <summary>
- Returns true if this 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.
- </summary>
- <remarks>
- <para>This property exists to help you sort documents that are digitally signed from those that are not.
- If you use Aspose.Words to modify and save a document that is digitally signed, then the digital signature will
- be lost. This is by design because a digital signature exists to guard the authenticity of a document.
- Using this property you can detect digitally signed documents before processing them in the same way as normal
- documents and take some action to avoid losing the digital signature, for example notify the user.
- </para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.FileFormatInfo.Encoding">
- <summary>
- Gets the detected encoding if applicable to the current document format.
- At the moment detects encoding only for HTML documents.
- </summary>
- </member>
- <member name="T:Aspose.Words.LoadOptions">
- <summary>
- Allows to specify additional options (such as password or base URI) when
- loading a document into a <see cref="T:Aspose.Words.Document" /> object.
- </summary>
- </member>
- <member name="M:Aspose.Words.LoadOptions.#ctor">
- <summary>
- Initializes a new instance of this class with default values.
- </summary>
- </member>
- <member name="M:Aspose.Words.LoadOptions.#ctor(System.String)">
- <summary>
- A shortcut to initialize a new instance of this class with the specified password to load an encrypted document.
- </summary>
- <param name="password">The password to open an encrypted document. Can be null or empty string.</param>
- </member>
- <member name="M:Aspose.Words.LoadOptions.#ctor(Aspose.Words.LoadFormat,System.String,System.String)">
- <summary>
- A shortcut to initialize a new instance of this class with properties set to the specified values.
- </summary>
- <param name="loadFormat">The format of the document to be loaded.</param>
- <param name="password">The password to open an encrypted document. Can be null or empty string.</param>
- <param name="baseUri">The string that will be used to resolve relative URIs to absolute. Can be null or empty string.</param>
- </member>
- <member name="M:Aspose.Words.LoadOptions.#ctor(Aspose.Words.LoadOptions)">
- <summary>
- Copy constructor.
- </summary>
- </member>
- <member name="P:Aspose.Words.LoadOptions.LoadFormat">
- <summary>
- Specifies the format of the document to be loaded.
- Default is <see cref="F:Aspose.Words.LoadFormat.Auto" />.
- </summary>
- <remarks>
- <para>It is recommended that you specify the <see cref="F:Aspose.Words.LoadFormat.Auto" /> value and let Aspose.Words detect
- the file format automatically. If you know the format of the document you are about to load, you can specify the format
- explicitly and this will slightly reduce the loading time by the overhead associated with auto detecting the format.
- If you specify an explicit load format and it will turn out to be wrong, the auto detection will be invoked and a second
- attempt to load the file will be made.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.LoadOptions.Password">
- <summary>
- Gets or sets the password for opening an encrypted document.
- Can be null or empty string. Default is null.
- </summary>
- <remarks>
- <para>You need to know the password to open an encrypted document. If the document is not encrypted, set this to null or empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.LoadOptions.BaseUri">
- <summary>
- Gets or sets the string that will be used to resolve relative URIs found in the document into absolute URIs when required.
- Can be null or empty string. Default is null.
- </summary>
- <remarks>
- <p>This property is used to resolve relative URIs into absolute in the following cases:</p>
- <list type="number">
- <item>When loading an HTML document from a stream and the document contains images with
- relative URIs and does not have a base URI specified in the BASE HTML element.</item>
- <item>When saving a document to PDF and other formats, to retrieve images linked using relative URIs
- so the images can be saved into the output document.</item>
- </list>
- </remarks>
- </member>
- <member name="P:Aspose.Words.LoadOptions.Encoding">
- <summary>
- Gets or sets the encoding that will be used to load an HTML, TXT, or CHM document if the encoding is not specified
- inside the document.
- Can be null. Default is null.
- </summary>
- <remarks>
- <para>This property is used only when loading HTML, TXT, or CHM documents.</para>
- <para>If encoding is not specified inside the document and this property is <c>null</c>, then the system will try to
- automatically detect the encoding.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.LoadOptions.ResourceLoadingCallback">
- <summary>
- Allows to control how external resources (images, style sheets) are loaded when a document is imported from HTML, MHTML.
- </summary>
- </member>
- <member name="P:Aspose.Words.LoadOptions.WarningCallback">
- <summary>
- Called during a load operation, when an issue is detected that might result in data or formatting fidelity loss.
- </summary>
- </member>
- <member name="P:Aspose.Words.LoadOptions.PreserveIncludePictureField">
- <summary>
- Gets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats.
- The default value is false.
- </summary>
- <remarks>
- <p>By default, the INCLUDEPICTURE field is converted into a shape object. You can override that if you need
- the field to be preserved, for example, if you wish to update it programmatically. Note however that this
- approach is not common for Aspose.Words. Use it on your own risk.</p>
- <p>One of the possible use cases may be using a MERGEFIELD as a child field to dynamically change the source path
- of the picture. In this case you need the INCLUDEPICTURE to be preserved in the model.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.LoadOptions.ConvertShapeToOfficeMath">
- <summary>
- Gets or sets whether to convert shapes with EquationXML to Office Math objects.
- </summary>
- </member>
- <member name="P:Aspose.Words.LoadOptions.FontSettings">
- <summary>
- Allows to specify document font settings.
- </summary>
- <remarks>
- <para>When loading some formats, Aspose.Words may require to resolve the fonts. For example, when loading HTML documents Aspose.Words
- may resolve the fonts to perform font fallback.</para>
- <para>If set to null, default static font settings <see cref="P:Aspose.Words.Fonts.FontSettings.DefaultInstance" /> will be used.</para>
- <para>The default value is null.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.LoadOptions.TempFolder">
- <summary>
- Allows to use temporary files when reading document.
- By default this property is <c>null</c> and no temporary files are used.
- </summary>
- <remarks>
- <para>The folder must exist and be writable, otherwise an exception will be thrown.</para>
- <para>Aspose.Words automatically deletes all temporary files when reading is complete.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.LoadOptions.ConvertMetafilesToPng">
- <summary>
- Gets or sets whether to convert metafile (<see cref="F:Aspose.FileFormat.Wmf" /> or <see cref="F:Aspose.FileFormat.Emf" />) images to <see cref="F:Aspose.FileFormat.Png" /> image format.
- </summary>
- <remarks>
- Metafiles (<see cref="F:Aspose.FileFormat.Wmf" /> or <see cref="F:Aspose.FileFormat.Emf" />) is an uncompressed image format and sometimes requires to much RAM to hold and process document.
- This option allows to convert all metafile images to <see cref="F:Aspose.FileFormat.Png" /> on document loading.
- Please note - conversion vector graphics to raster decreases quality of the images.
- </remarks>
- </member>
- <member name="P:Aspose.Words.LoadOptions.MswVersion">
- <summary>
- Allows to specify that the document loading process should match a specific MS Word version.
- Default value is <see cref="F:Aspose.Words.Settings.MsWordVersion.Word2007" /></summary>
- <remarks>
- Different Word versions may handle certain aspects of document content and formatting slightly differently
- during the loading process, which may result in minor differences in Document Object Model.
- </remarks>
- </member>
- <member name="P:Aspose.Words.LoadOptions.UpdateDirtyFields">
- <summary>
- Specifies whether to update the fields with the <c>dirty</c> attribute.
- </summary>
- </member>
- <member name="P:Aspose.Words.LoadOptions.LanguagePreferences">
- <summary>
- Gets language preferences that will be used when document is loading.
- </summary>
- </member>
- <member name="T:Aspose.Words.WarningInfo">
- <summary>
- Contains information about a warning that Aspose.Words issued during document loading or saving.
- </summary>
- <remarks>
- <para>You do not create instances of this class. Objects of this class are created
- and passed by Aspose.Words to the <see cref="M:Aspose.Words.IWarningCallback.Warning(Aspose.Words.WarningInfo)" /> method.</para>
- <seealso cref="T:Aspose.Words.IWarningCallback" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.WarningInfo.WarningType">
- <summary>
- Returns the type of the warning.
- </summary>
- </member>
- <member name="P:Aspose.Words.WarningInfo.Description">
- <summary>
- Returns the description of the warning.
- </summary>
- </member>
- <member name="P:Aspose.Words.WarningInfo.Source">
- <summary>
- Returns the source of the warning.
- </summary>
- </member>
- <member name="T:Aspose.Words.WarningInfoCollection">
- <summary>
- Represents a typed collection of <see cref="T:Aspose.Words.WarningInfo" /> objects.
- </summary>
- <remarks>
- <para>You can use this collection object as the simplest form of <see cref="T:Aspose.Words.IWarningCallback" /> implementation to gather
- all warnings that Aspose.Words generates during a load or save operation. Create an instance of this class and assign it
- to the <see cref="P:Aspose.Words.LoadOptions.WarningCallback" /> or <see cref="P:Aspose.Words.DocumentBase.WarningCallback" /> property.</para>
- <seealso cref="T:Aspose.Words.WarningInfo" />
- <seealso cref="T:Aspose.Words.IWarningCallback" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.WarningInfoCollection.GetEnumerator">
- <summary>
- Returns an enumerator object that can be used to iterate over all items in the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.WarningInfoCollection.Clear">
- <summary>
- Removes all elements from the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.WarningInfoCollection.Warning(Aspose.Words.WarningInfo)">
- <summary>
- Implements the <see cref="T:Aspose.Words.IWarningCallback" /> interface. Adds a warning to this collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.WarningInfoCollection.Count">
- <summary>
- Gets the number of elements contained in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.WarningInfoCollection.Item(System.Int32)">
- <summary>
- Gets an item at the specified index.
- </summary>
- <param name="index">Zero-based index of the item.</param>
- </member>
- <member name="T:Aspose.Words.WarningSource">
- <summary>
- Specifies the module that produces a warning during document loading or saving.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Unknown">
- <summary>
- The warning source is not specified.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Layout">
- <summary>
- Module that builds a document layout.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.DrawingML">
- <summary>
- Module that renders DrawingML shapes.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.OfficeMath">
- <summary>
- Module that renders OfficeMath.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Shapes">
- <summary>
- Module that renders ordinary shapes.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Metafile">
- <summary>
- Module that renders metafiles.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Xps">
- <summary>
- Module that renders XPS.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Pdf">
- <summary>
- Module that renders PDF.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Image">
- <summary>
- Module that renders images.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Docx">
- <summary>
- Module that reads/writes DOCX files.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Doc">
- <summary>
- Module that reads/writes binary DOC files.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Text">
- <summary>
- Module that reads/writes plaintext files.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Rtf">
- <summary>
- Module that reads/writes RTF files.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.WordML">
- <summary>
- Module that reads/writes WML files.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Nrx">
- <summary>
- Common modules that are shared between DOCX/WML reader/writer modules.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Odt">
- <summary>
- Module that reads/writes ODT files.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Html">
- <summary>
- Module that reads/writes HTML/MHTML files.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Validator">
- <summary>
- Module that verifies model consistency and validity.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Xaml">
- <summary>
- Module that reads/writes Xaml files.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Svm">
- <summary>
- Module that reads Svm files.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.MathML">
- <summary>
- Module that reads W3C MathML files.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Font">
- <summary>
- Module that reads font files.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Svg">
- <summary>
- Module that reads SVG files.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Markdown">
- <summary>
- Module that reads/writes Markdown files.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningSource.Chm">
- <summary>
- Module that reads CHM files.
- </summary>
- </member>
- <member name="T:Aspose.Words.WarningType">
- <summary>
- Specifies the type of a warning that is issued by Aspose.Words during document loading or saving.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningType.DataLossCategory">
- <summary>
- Some text/char/image or other data will be missing from either the document tree following load,
- or from the created document following save.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningType.DataLoss">
- <summary>
- Generic data loss, no specific code.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningType.MajorFormattingLossCategory">
- <summary>
- The resulting document or a particular location in it might look substantially different
- compared to the original document.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningType.MajorFormattingLoss">
- <summary>
- Generic major formatting loss, no specific code.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningType.MinorFormattingLossCategory">
- <summary>
- The resulting document or a particular location in it might look somewhat different compared
- to the original document.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningType.MinorFormattingLoss">
- <summary>
- Generic minor formatting loss, no specific code.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningType.FontSubstitution">
- <summary>
- Font has been substituted.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningType.FontEmbedding">
- <summary>
- Loss of embedded font information during document saving.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningType.UnexpectedContentCategory">
- <summary>
- Some content in the source document could not be recognized (i.e. is unsupported), this may or may not
- cause issues or result in data/formatting loss.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningType.UnexpectedContent">
- <summary>
- Generic unexpected content, no specific code.
- </summary>
- </member>
- <member name="F:Aspose.Words.WarningType.Hint">
- <summary>
- Advises of a potential problem or suggests an improvement.
- </summary>
- </member>
- <member name="T:Aspose.Words.IWarningCallback">
- <summary>
- 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.
- </summary>
- </member>
- <member name="M:Aspose.Words.IWarningCallback.Warning(Aspose.Words.WarningInfo)">
- <summary>
- Aspose.Words invokes this method when it encounters some issue during document loading
- or saving that might result in loss of formatting or data fidelity.
- </summary>
- </member>
- <member name="T:Aspose.Words.Bookmark">
- <summary>
- Represents a single bookmark.
- </summary>
- <remarks>
- <p>
- <see cref="T:Aspose.Words.Bookmark" /> is a "facade" object that encapsulates two nodes <see cref="P:Aspose.Words.Bookmark.BookmarkStart" />
- and <see cref="P:Aspose.Words.Bookmark.BookmarkEnd" /> in a document tree and allows to work with a bookmark as a single object.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Bookmark.Remove">
- <summary>
- Removes the bookmark from the document. Does not remove text inside the bookmark.
- </summary>
- </member>
- <member name="P:Aspose.Words.Bookmark.Name">
- <summary>
- Gets or sets the name of the bookmark.
- </summary>
- <remarks>
- Note that if you change the name of a bookmark to a name that already exists in the document,
- no error will be given and only the first bookmark will be stored when you save the document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Bookmark.Text">
- <summary>
- Gets or sets the text enclosed in the bookmark.
- </summary>
- </member>
- <member name="P:Aspose.Words.Bookmark.BookmarkStart">
- <summary>
- Gets the node that represents the start of the bookmark.
- </summary>
- </member>
- <member name="P:Aspose.Words.Bookmark.BookmarkEnd">
- <summary>
- Gets the node that represents the end of the bookmark.
- </summary>
- </member>
- <member name="P:Aspose.Words.Bookmark.IsColumn">
- <summary>
- Returns <b>true</b> if this bookmark is a table column bookmark.
- </summary>
- </member>
- <member name="P:Aspose.Words.Bookmark.FirstColumn">
- <summary>
- Gets the zero-based index of the first column of the table column range associated with the bookmark.
- </summary>
- <remarks>
- Returns <b>-1</b> if this bookmark is not a table column bookmark.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Bookmark.LastColumn">
- <summary>
- Gets the zero-based index of the last column of the table column range associated with the bookmark.
- </summary>
- <remarks>
- Returns <b>-1</b> if this bookmark is not a table column bookmark.
- </remarks>
- </member>
- <member name="T:Aspose.Words.BookmarkEnd">
- <summary>
- Represents an end of a bookmark in a Word document.
- </summary>
- <remarks>
- <p>A complete bookmark in a Word document consists of a <see cref="T:Aspose.Words.BookmarkStart" />
- and a matching <see cref="T:Aspose.Words.BookmarkEnd" /> with the same bookmark name.</p>
- <p>
- <see cref="T:Aspose.Words.BookmarkStart" /> and <see cref="T:Aspose.Words.BookmarkEnd" /> are just markers inside a document
- that specify where the bookmark starts and ends.</p>
- <p>Use the <see cref="T:Aspose.Words.Bookmark" /> class as a "facade" to work with a bookmark
- as a single object.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.BookmarkEnd.#ctor(Aspose.Words.DocumentBase,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Aspose.Words.BookmarkEnd" /> class.
- </summary>
- <param name="doc">The owner document.</param>
- <param name="name">The name of the bookmark. Cannot be null.</param>
- </member>
- <member name="M:Aspose.Words.BookmarkEnd.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitBookmarkEnd(Aspose.Words.BookmarkEnd)" />.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the node.</param>
- <returns>False if the visitor requested the enumeration to stop.</returns>
- </member>
- <member name="P:Aspose.Words.BookmarkEnd.NodeType">
- <summary>
- Returns <see cref="F:Aspose.Words.NodeType.BookmarkEnd" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.BookmarkEnd.Name">
- <summary>
- Gets or sets the bookmark name.
- </summary>
- <remarks>
- <para>Cannot be null.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.BookmarkCollection">
- <summary>
- A collection of <see cref="T:Aspose.Words.Bookmark" /> objects that represent the bookmarks in the specified range.
- </summary>
- </member>
- <member name="M:Aspose.Words.BookmarkCollection.Remove(Aspose.Words.Bookmark)">
- <summary>
- Removes the specified bookmark from the document.
- </summary>
- <param name="bookmark">The bookmark to remove.</param>
- </member>
- <member name="M:Aspose.Words.BookmarkCollection.Remove(System.String)">
- <summary>
- Removes a bookmark with the specified name.
- </summary>
- <param name="bookmarkName">The case-insensitive name of the bookmark to remove.</param>
- </member>
- <member name="M:Aspose.Words.BookmarkCollection.RemoveAt(System.Int32)">
- <summary>
- Removes a bookmark at the specified index.
- </summary>
- <param name="index">The zero-based index of the bookmark to remove.</param>
- </member>
- <member name="M:Aspose.Words.BookmarkCollection.Clear">
- <summary>
- Removes all bookmarks from this collection and from the document.
- </summary>
- </member>
- <member name="M:Aspose.Words.BookmarkCollection.GetEnumerator">
- <summary>
- Returns an enumerator object.
- </summary>
- </member>
- <member name="P:Aspose.Words.BookmarkCollection.Count">
- <summary>
- Returns the number of bookmarks in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.BookmarkCollection.Item(System.Int32)">
- <summary>
- Returns a bookmark at the specified index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the collection.</param>
- </member>
- <member name="P:Aspose.Words.BookmarkCollection.Item(System.String)">
- <summary>
- Returns a bookmark by name.
- </summary>
- <remarks>
- <p>Returns null if the bookmark with the specified name cannot be found.</p>
- </remarks>
- <param name="bookmarkName">Case-insensitive name of the bookmark.</param>
- </member>
- <member name="T:Aspose.Words.BookmarkStart">
- <summary>
- Represents a start of a bookmark in a Word document.
- </summary>
- <remarks>
- <p>A complete bookmark in a Word document consists of a <see cref="T:Aspose.Words.BookmarkStart" />
- and a matching <see cref="T:Aspose.Words.BookmarkEnd" /> with the same bookmark name.</p>
- <p>
- <see cref="T:Aspose.Words.BookmarkStart" /> and <see cref="T:Aspose.Words.BookmarkEnd" /> are just markers inside a document
- that specify where the bookmark starts and ends.</p>
- <p>Use the <see cref="P:Aspose.Words.BookmarkStart.Bookmark" /> class as a "facade" to work with a bookmark
- as a single object.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.BookmarkStart.#ctor(Aspose.Words.DocumentBase,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Aspose.Words.BookmarkStart" /> class.
- </summary>
- <param name="doc">The owner document.</param>
- <param name="name">The name of the bookmark. Cannot be null.</param>
- </member>
- <member name="M:Aspose.Words.BookmarkStart.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitBookmarkStart(Aspose.Words.BookmarkStart)" />.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the node.</param>
- <returns>False if the visitor requested the enumeration to stop.</returns>
- </member>
- <member name="M:Aspose.Words.BookmarkStart.GetText">
- <summary>
- Returns an empty string.
- </summary>
- <returns>An empty string.</returns>
- </member>
- <member name="P:Aspose.Words.BookmarkStart.NodeType">
- <summary>
- Returns <see cref="F:Aspose.Words.NodeType.BookmarkStart" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.BookmarkStart.Bookmark">
- <summary>
- Gets the facade object that encapsulates this bookmark start and end.
- </summary>
- </member>
- <member name="P:Aspose.Words.BookmarkStart.Name">
- <summary>
- Gets or sets the bookmark name.
- </summary>
- <remarks>
- <para>Cannot be null.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Border">
- <summary>
- Represents a border of an object.
- </summary>
- <remarks>
- <p>Borders can be applied to various document elements including paragraph,
- run of text inside a paragraph or a table cell.</p>
- </remarks>
- <dev>
- This is a model and also presentation class that allows to see and modify border attributes.
- </dev>
- </member>
- <member name="M:Aspose.Words.Border.ClearFormatting">
- <summary>
- Resets border properties to default values.
- </summary>
- <remarks>
- When border properties are reset to default values, the border is invisible.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Border.Equals(Aspose.Words.Border)">
- <summary>
- Determines whether the specified border is equal in value to the current border.
- </summary>
- </member>
- <member name="M:Aspose.Words.Border.Equals(System.Object)">
- <summary>
- Determines whether the specified object is equal in value to the current object.
- </summary>
- </member>
- <member name="M:Aspose.Words.Border.GetHashCode">
- <summary>
- Serves as a hash function for this type.
- </summary>
- </member>
- <member name="P:Aspose.Words.Border.LineStyle">
- <summary>
- Gets or sets the border style.
- </summary>
- <remarks>
- <para>If you set line style to none, then line width is automatically changed to zero.</para>
- </remarks>
- <dev>
- Currently AW distinguish Nil and None borders.
- This public setter is used by customer and always creates Nil border for LineStyle.None
- Readers and internal code should use <see cref="P:Aspose.Words.Border.LineStyleInternal" /> setter with LineStyle.None to create None.Border and
- <see cref="M:Aspose.Words.Border.CreateNilBorder" /> method to create Nil border.
- </dev>
- </member>
- <member name="P:Aspose.Words.Border.LineWidth">
- <summary>
- Gets or sets the border width in points.
- </summary>
- <remarks>
- <p>If you set line width greater than zero when line style is none, the line style is
- automatically changed to single line.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Border.IsVisible">
- <summary>
- Returns true if the LineStyle is not LineStyle.None.
- </summary>
- </member>
- <member name="P:Aspose.Words.Border.Color">
- <summary>
- Gets or sets the border color.
- </summary>
- </member>
- <member name="P:Aspose.Words.Border.DistanceFromText">
- <summary>
- Gets or sets distance of the border from text or from the page edge in points.
- </summary>
- <remarks>
- Has no effect and will be automatically reset to zero for borders of table cells.
-
- <seealso cref="P:Aspose.Words.PageSetup.BorderDistanceFrom" /></remarks>
- </member>
- <member name="P:Aspose.Words.Border.Shadow">
- <summary>
- Gets or sets a value indicating whether the border has a shadow.
- </summary>
- <remarks>
- <p>In Microsoft Word, for a border to have a shadow, the borders on all four sides
- (left, top, right and bottom) should be of the same type, width, color and all should have
- the Shadow property set to true.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.BorderCollection">
- <summary>
- A collection of Border objects.
- </summary>
- <remarks>
- Different document elements have different borders.
- For example, ParagraphFormat has Bottom, Left, Right and Top borders.
- You can specify different formatting for each border independently or
- enumerate through all borders and apply same formatting.
- </remarks>
- <dev>
- This is a presentation object only, does not store any model data.
- </dev>
- </member>
- <member name="M:Aspose.Words.BorderCollection.Equals(Aspose.Words.BorderCollection)">
- <summary>
- Compares collections of borders.
- </summary>
- </member>
- <member name="M:Aspose.Words.BorderCollection.ClearFormatting">
- <summary>
- Removes all borders of an object.
- </summary>
- </member>
- <member name="M:Aspose.Words.BorderCollection.GetEnumerator">
- <summary>
- Returns an enumerator object that can be used to iterate over all borders in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.BorderCollection.Item(Aspose.Words.BorderType)">
- <overloads>Retrieves a Border object.</overloads>
- <summary>
- Retrieves a Border object by border type.
- </summary>
- <remarks>
- <p>Note that not all borders are present for different document elements.
- This method throws an exception if you request a border not applicable to the current object.</p>
- </remarks>
- <param name="borderType">A <see cref="T:Aspose.Words.BorderType" /> value
- that specifies the type of the border to retrieve.</param>
- </member>
- <member name="P:Aspose.Words.BorderCollection.Item(System.Int32)">
- <summary>
- Retrieves a Border object by index.
- </summary>
- <param name="index">Zero-based index of the border to retrieve.</param>
- </member>
- <member name="P:Aspose.Words.BorderCollection.Left">
- <summary>
- Gets the left border.
- </summary>
- </member>
- <member name="P:Aspose.Words.BorderCollection.Right">
- <summary>
- Gets the right border.
- </summary>
- </member>
- <member name="P:Aspose.Words.BorderCollection.Top">
- <summary>
- Gets the top border.
- </summary>
- </member>
- <member name="P:Aspose.Words.BorderCollection.Bottom">
- <summary>
- Gets the bottom border.
- </summary>
- </member>
- <member name="P:Aspose.Words.BorderCollection.Horizontal">
- <summary>
- Gets the horizontal border that is used between cells or conforming paragraphs.
- </summary>
- </member>
- <member name="P:Aspose.Words.BorderCollection.Vertical">
- <summary>
- Gets the vertical border that is used between cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.BorderCollection.Count">
- <summary>
- Gets the number of borders in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.BorderCollection.LineWidth">
- <summary>
- Gets or sets the border width in points.
- </summary>
- <remarks>
- <p>Returns the width of the first border in the collection.</p>
- <p>Sets the width of all borders in the collection excluding diagonal borders.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.BorderCollection.LineStyle">
- <summary>
- Gets or sets the border style.
- </summary>
- <remarks>
- <p>Returns the style of the first border in the collection.</p>
- <p>Sets the style of all borders in the collection excluding diagonal borders.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.BorderCollection.Color">
- <summary>
- Gets or sets the border color.
- </summary>
- <remarks>
- <p>Returns the color of the first border in the collection.</p>
- <p>Sets the color of all borders in the collection excluding diagonal borders.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.BorderCollection.DistanceFromText">
- <summary>
- Gets or sets distance of the border from text in points.
- </summary>
- <remarks>
- <p>Gets the distance from text for the first border.</p>
- <p>Sets the distance from text for all borders in the collection excluding diagonal borders.</p>
- <p>Has no effect and will be automatically reset to zero for borders of table cells.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.BorderCollection.Shadow">
- <summary>
- Gets or sets a value indicating whether the border has a shadow.
- </summary>
- <remarks>
- <p>Gets the value from the first border in the collection.</p>
- <p>Sets the value for all borders in the collection excluding diagonal borders.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.BorderType">
- <summary>
- Specifies sides of a border.
- </summary>
- </member>
- <member name="F:Aspose.Words.BorderType.None">
- <summary>
- Default value.
- </summary>
- </member>
- <member name="F:Aspose.Words.BorderType.Bottom">
- <summary>
- Specifies the bottom border of a paragraph or a table cell.
- </summary>
- </member>
- <member name="F:Aspose.Words.BorderType.Left">
- <summary>
- Specifies the left border of a paragraph or a table cell.
- </summary>
- </member>
- <member name="F:Aspose.Words.BorderType.Right">
- <summary>
- Specifies the right border of a paragraph or a table cell.
- </summary>
- </member>
- <member name="F:Aspose.Words.BorderType.Top">
- <summary>
- Specifies the top border of a paragraph or a table cell.
- </summary>
- </member>
- <member name="F:Aspose.Words.BorderType.Horizontal">
- <summary>
- Specifies the horizontal border between cells in a table or between conforming paragraphs.
- </summary>
- </member>
- <member name="F:Aspose.Words.BorderType.Vertical">
- <summary>
- Specifies the vertical border between cells in a table.
- </summary>
- </member>
- <member name="F:Aspose.Words.BorderType.DiagonalDown">
- <summary>
- Specifies the diagonal border in a table cell.
- </summary>
- </member>
- <member name="F:Aspose.Words.BorderType.DiagonalUp">
- <summary>
- Specifies the diagonal border in a table cell.
- </summary>
- </member>
- <member name="T:Aspose.Words.LineStyle">
- <summary>
- Specifies line style of a <see cref="T:Aspose.Words.Border" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.None">
- <summary>
- </summary>
- <dev>
- In MS Word binary format LineStyle.None means no border for all objects, except table cells.
-
- For table cells LineStyle.None means inherit from the default table border.
-
- Apparently this looks like a very bad hack made by someone at MS and I work around it
- by making LineStyle.None to mean "no border" for any object in the model including table cells.
- The translation is performed in the binary cell reader/writer.
-
- I also use a single approach to indicate that a border is inherited. At first the border attribute
- is simply missing, but if a use requests it, a Border object is instantiated in "inherited" mode.
-
- DS 12.10.2010. Right now the enum contains the continuous range of values and it is used in
- Border.HasValidLineStyle to define if a line style belongs to the enum or not. If new values
- are added to the enum then Border.HasValidLineStyle should be reworked correspondingly.
- </dev>
- </member>
- <member name="F:Aspose.Words.LineStyle.Single">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.Thick">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.Double">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.Hairline">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.Dot">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.DashLargeGap">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.DotDash">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.DotDotDash">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.Triple">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.ThinThickSmallGap">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.ThickThinSmallGap">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.ThinThickThinSmallGap">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.ThinThickMediumGap">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.ThickThinMediumGap">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.ThinThickThinMediumGap">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.ThinThickLargeGap">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.ThickThinLargeGap">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.ThinThickThinLargeGap">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.Wave">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.DoubleWave">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.DashSmallGap">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.DashDotStroker">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.Emboss3D">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.Engrave3D">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.Outset">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.LineStyle.Inset">
- <summary>
- </summary>
- </member>
- <member name="T:Aspose.Words.Shading">
- <summary>
- Contains shading attributes for an object.
- </summary>
- <dev>
- This is a model and also presentation class that allows to see and modify shading attributes.
- </dev>
- </member>
- <member name="M:Aspose.Words.Shading.ClearFormatting">
- <summary>
- Removes shading from the object.
- </summary>
- </member>
- <member name="M:Aspose.Words.Shading.Equals(Aspose.Words.Shading)">
- <summary>
- Determines whether the specified Shading is equal in value to the current Shading.
- </summary>
- </member>
- <member name="M:Aspose.Words.Shading.Equals(System.Object)">
- <summary>
- Determines whether the specified object is equal in value to the current object.
- </summary>
- </member>
- <member name="M:Aspose.Words.Shading.GetHashCode">
- <summary>
- Serves as a hash function for this type.
- </summary>
- </member>
- <member name="P:Aspose.Words.Shading.BackgroundPatternColor">
- <summary>
- Gets or sets the color that's applied to the background of the Shading object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Shading.ForegroundPatternColor">
- <summary>
- Gets or sets the color that's applied to the foreground of the Shading object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Shading.Texture">
- <summary>
- Gets or sets the shading texture.
- </summary>
- </member>
- <member name="T:Aspose.Words.TextureIndex">
- <summary>
- Specifies shading texture.
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture10Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture12Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture15Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture17Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture20Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture22Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture25Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture27Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture2Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture30Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture32Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture35Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture37Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture40Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture42Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture45Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture47Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture50Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture52Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture55Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture57Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture60Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture62Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture65Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture67Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture70Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture72Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture75Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture77Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture7Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture80Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture82Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture85Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture87Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture90Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture92Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture95Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.Texture97Pt5Percent">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureCross">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureDarkCross">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureDarkDiagonalCross">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureDarkDiagonalDown">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureDarkDiagonalUp">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureDarkHorizontal">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureDarkVertical">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureDiagonalCross">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureDiagonalDown">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureDiagonalUp">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureHorizontal">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureNone">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureSolid">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureVertical">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextureIndex.TextureNil">
- <summary>
- Specifies that there shall be no pattern used on the current shaded region
- (i.e. the pattern shall be a complete fill with the background color).
- </summary>
- <dev>
- Actually the Word does not renders shading with such pattern type i.e. shading is invisible (WORDSNET-17402).
- </dev>
- </member>
- <member name="T:Aspose.Words.AbsolutePositionTab">
- <summary>
- 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.
- </summary>
- </member>
- <member name="M:Aspose.Words.AbsolutePositionTab.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Calls DocumentVisitor.VisitAbsolutePositionTab.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the node.</param>
- <returns>False if the visitor requested the enumeration to stop.</returns>
- </member>
- <member name="T:Aspose.Words.CompositeNode">
- <summary>
- Base class for nodes that can contain other nodes.
- </summary>
- <remarks>
- <p>A document is represented as a tree of nodes, similar to DOM or XmlDocument.</p>
- <p>For more info see the Composite design pattern.</p>
- <p>The <see cref="T:Aspose.Words.CompositeNode" /> class:</p>
- <list type="bullet">
- <item>Provides access to the child nodes.</item>
- <item>Implements Composite operations such as insert and remove children.</item>
- <item>Provides methods for XPath navigation.</item>
- </list>
- </remarks>
- <dev>
- Maintains a pointer to the list of children.
-
- Provides helper methods to insert or remove a whole range of nodes.
-
- Inserting and removing children are the most important features here.
-
- Public API methods for insert and remove verify the arguments well and raise the insert/delete
- node events to the owner document.
-
- The child nodes are stored in a doubly linked list and the composite node knows its first and last children.
- This approach was taken from XmlElement (with addition of doubly linking). Inserting or removing a node just
- means updating the PrevSibling, NextSibling and ParentNode of the appropriate nodes.
- </dev>
- </member>
- <member name="M:Aspose.Words.CompositeNode.GetText">
- <summary>
- Gets the text of this node and of all its children.
- </summary>
- <remarks>
- <p>The returned string includes all control and special characters as described in <see cref="T:Aspose.Words.ControlChar" />.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.CompositeNode.GetChildNodes(Aspose.Words.NodeType,System.Boolean)">
- <overloads>Returns a collection of child nodes that match the specified type.</overloads>
- <summary>
- Returns a live collection of child nodes that match the specified type.
- </summary>
- <remarks>
- <p>The collection of nodes returned by this method is always live.</p>
- <remarks>
- <p>A live collection is always in sync with the document. For example, if you
- selected all sections in a document and enumerate through the collection
- deleting the sections, the section is removed from the collection immediately
- when it is removed from the document.</p>
- </remarks>
- </remarks>
- <param name="nodeType">Specifies the type of nodes to select.</param>
- <param name="isDeep">True to select from all child nodes recursively.
- False to select only among immediate children. </param>
- <returns>A live collection of child nodes of the specified type.</returns>
- </member>
- <member name="M:Aspose.Words.CompositeNode.GetChildNodes(Aspose.Words.NodeType[],System.Boolean)">
- <summary>
- Returns a live collection of child nodes that match the specified types.
- </summary>
- </member>
- <member name="M:Aspose.Words.CompositeNode.GetChild(Aspose.Words.NodeType,System.Int32,System.Boolean)">
- <summary>
- Returns an Nth child node that matches the specified type.
- </summary>
- <remarks>
- <p>If index is out of range, a null is returned.</p>
- </remarks>
- <param name="nodeType">Specifies the type of the child node.</param>
- <param name="index">Zero based index of the child node to select.
- Negative indexes are also allowed and indicate access from the end,
- that is -1 means the last node.</param>
- <param name="isDeep">True to select from all child nodes recursively.
- False to select only among immediate children. See remarks for more info.</param>
- <returns>The child node that matches the criteria or null if no matching node is found.</returns>
- <remarks>Note that markup nodes (<see cref="F:Aspose.Words.NodeType.StructuredDocumentTag" /> and <see cref="F:Aspose.Words.NodeType.SmartTag" />)
- are traversed even when isDeep = false and GetChild is invoked for non-markup node type. For example if the first run in a para
- is wrapped in a StructuredDocumentTag, it will still be returned by GetChild(NodeType.Run, 0, false).</remarks>
- </member>
- <member name="M:Aspose.Words.CompositeNode.SelectNodes(System.String)">
- <summary>
- Selects a list of nodes matching the XPath expression.
- </summary>
- <remarks>
- <p>Only expressions with element names are supported at the moment. Expressions
- that use attribute names are not supported.</p>
- </remarks>
- <param name="xpath">The XPath expression.</param>
- <returns>A list of nodes matching the XPath query.</returns>
- </member>
- <member name="M:Aspose.Words.CompositeNode.SelectSingleNode(System.String)">
- <summary>
- Selects the first Node that matches the XPath expression.
- </summary>
- <remarks>
- <p>Only expressions with element names are supported at the moment. Expressions
- that use attribute names are not supported.</p>
- </remarks>
- <param name="xpath">The XPath expression.</param>
- <returns>The first Node that matches the XPath query or null if no matching node is found.</returns>
- </member>
- <member name="M:Aspose.Words.CompositeNode.GetEnumerator">
- <summary>
- Provides support for the for each style iteration over the child nodes of this node.
- </summary>
- </member>
- <member name="M:Aspose.Words.CompositeNode.AppendChild(Aspose.Words.Node)">
- <summary>
- Adds the specified node to the end of the list of child nodes for this node.
- </summary>
- <remarks>
- <p>If the newChild is already in the tree, it is first removed.</p>
- <p>If the node being inserted was created from another document, you should use
- <see cref="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)" /> to import the node to the current document.
- The imported node can then be inserted into the current document.</p>
- </remarks>
- <param name="newChild">The node to add.</param>
- <returns>The node added.</returns>
- </member>
- <member name="M:Aspose.Words.CompositeNode.PrependChild(Aspose.Words.Node)">
- <summary>
- Adds the specified node to the beginning of the list of child nodes for this node.
- </summary>
- <remarks>
- <p>If the newChild is already in the tree, it is first removed.</p>
- <p>If the node being inserted was created from another document, you should use
- <see cref="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)" /> to import the node to the current document.
- The imported node can then be inserted into the current document.</p>
- </remarks>
- <param name="newChild">The node to add.</param>
- <returns>The node added.</returns>
- </member>
- <member name="M:Aspose.Words.CompositeNode.InsertAfter(Aspose.Words.Node,Aspose.Words.Node)">
- <summary>
- Inserts the specified node immediately after the specified reference node.
- </summary>
- <remarks>
- <p>If refChild is null, inserts newChild at the beginning of the list of child nodes.</p>
- </remarks>
- <remarks>
- <p>If the newChild is already in the tree, it is first removed.</p>
- <p>If the node being inserted was created from another document, you should use
- <see cref="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)" /> to import the node to the current document.
- The imported node can then be inserted into the current document.</p>
- </remarks>
- <param name="newChild">The Node to insert.</param>
- <param name="refChild">The Node that is the reference node. The newNode is placed after the refNode. </param>
- <returns>The inserted node.</returns>
- </member>
- <member name="M:Aspose.Words.CompositeNode.InsertBefore(Aspose.Words.Node,Aspose.Words.Node)">
- <summary>
- Inserts the specified node immediately before the specified reference node.
- </summary>
- <remarks>
- <p>If refChild is null, inserts newChild at the end of the list of child nodes.</p>
- </remarks>
- <remarks>
- <p>If the newChild is already in the tree, it is first removed.</p>
- <p>If the node being inserted was created from another document, you should use
- <see cref="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)" /> to import the node to the current document.
- The imported node can then be inserted into the current document.</p>
- </remarks>
- <param name="newChild">The Node to insert.</param>
- <param name="refChild">The Node that is the reference node. The newChild is placed before this node.</param>
- <returns>The inserted node.</returns>
- </member>
- <member name="M:Aspose.Words.CompositeNode.RemoveChild(Aspose.Words.Node)">
- <summary>
- Removes the specified child node.
- </summary>
- <remarks>
- <p>The parent of oldChild is set to null after the node is removed.</p>
- </remarks>
- <param name="oldChild">The node to remove.</param>
- <returns>The removed node.</returns>
- </member>
- <member name="M:Aspose.Words.CompositeNode.RemoveAllChildren">
- <summary>
- Removes all the child nodes of the current node.
- </summary>
- </member>
- <member name="M:Aspose.Words.CompositeNode.RemoveSmartTags">
- <summary>
- Removes all <see cref="T:Aspose.Words.Markup.SmartTag" /> descendant nodes of the current node.
- </summary>
- <remarks>This method does not remove the content of the smart tags.</remarks>
- </member>
- <member name="M:Aspose.Words.CompositeNode.InsertBefore(Aspose.Words.Node,Aspose.Words.Node,Aspose.Words.Node)">
- <summary>
- Inserts nodes starting from the start node up to, but not including the end node
- into this node before the reference node.
- </summary>
- <param name="start">Node to start moving from.</param>
- <param name="end">Can be null to indicate move all from start to the end.</param>
- <param name="refNode">The nodes will be inserted before this node.</param>
- </member>
- <member name="M:Aspose.Words.CompositeNode.InsertAfter(Aspose.Words.Node,Aspose.Words.Node,Aspose.Words.Node)">
- <summary>
- Inserts nodes starting from the start node up to, but not including the end node
- into this node after the reference node.
- </summary>
- <param name="start">Node to start moving from.</param>
- <param name="end">Can be null to indicate move all from start to the end.</param>
- <param name="refNode">The nodes will be inserted after this node.</param>
- </member>
- <member name="M:Aspose.Words.CompositeNode.IndexOf(Aspose.Words.Node)">
- <summary>
- Returns the index of the specified child node in the child node array.
- </summary>
- <remarks>
- Returns -1 if the node is not found in the child nodes.
- </remarks>
- </member>
- <member name="M:Aspose.Words.CompositeNode.CreateNavigator">
- <summary>
- Reserved for system use. IXPathNavigable.
- </summary>
- </member>
- <member name="P:Aspose.Words.CompositeNode.IsComposite">
- <summary>
- Returns true as this node can have child nodes.
- </summary>
- </member>
- <member name="P:Aspose.Words.CompositeNode.HasChildNodes">
- <summary>
- Returns true if this node has any child nodes.
- </summary>
- </member>
- <member name="P:Aspose.Words.CompositeNode.ChildNodes">
- <summary>
- Gets all immediate child nodes of this node.
- </summary>
- <remarks>
- <p>Note, <see cref="P:Aspose.Words.CompositeNode.ChildNodes" /> is equivalent to calling <c>GetChildNodes(NodeType.Any, false)</c>
- and creates and returns a new collection every time it is accessed.</p>
- <p>If there are no child nodes, this property returns an empty collection.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.CompositeNode.FirstChild">
- <summary>
- Gets the first child of the node.
- </summary>
- <remarks>
- If there is no first child node, a null is returned.
- </remarks>
- </member>
- <member name="P:Aspose.Words.CompositeNode.LastChild">
- <summary>
- Gets the last child of the node.
- </summary>
- <remarks>
- If there is no last child node, a null is returned.
- </remarks>
- </member>
- <member name="P:Aspose.Words.CompositeNode.Count">
- <summary>
- Gets the number of immediate children of this node.
- </summary>
- </member>
- <member name="T:Aspose.Words.Node">
- <summary>
- Base class for all nodes of a Word document.
- </summary>
- <remarks>
- <p>A document is represented as a tree of nodes, similar to DOM or XmlDocument.</p>
- <p>For more info see the Composite design pattern.</p>
- <p>The <see cref="T:Aspose.Words.Node" /> class:</p>
- <list type="bullet">
- <item>Defines the child node interface.</item>
- <item>Defines the interface for visiting nodes.</item>
- <item>Provides default cloning capability.</item>
- <item>Implements parent node and owner document mechanisms.</item>
- <item>Implements access to sibling nodes.</item>
- </list>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Node.Clone(System.Boolean)">
- <summary>
- Creates a duplicate of the node.
- </summary>
- <remarks>
- <p>This method serves as a copy constructor for nodes.
- The cloned node has no parent, but belongs to the same document as the original node.</p>
- <p>This method always performs a deep copy of the node. The <i>isCloneChildren</i> parameter
- specifies whether to perform copy all child nodes as well.</p>
- </remarks>
- <param name="isCloneChildren">True to recursively clone the subtree under the specified node;
- false to clone only the node itself.</param>
- <returns>The cloned node.</returns>
- <dev>
- You should use the <see cref="M:Aspose.Words.Node.Clone(System.Boolean,Aspose.Words.INodeCloningListener)" /> overload when
- the node cloning is a part of another (usually composite) node cloning process.
- And you should pass down the <see cref="T:Aspose.Words.INodeCloningListener" /> parameter in this case.
- </dev>
- </member>
- <member name="M:Aspose.Words.Node.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- </member>
- <member name="M:Aspose.Words.Node.GetText">
- <summary>
- Gets the text of this node and of all its children.
- </summary>
- <remarks>
- <p>The returned string includes all control and special characters as described in <see cref="T:Aspose.Words.ControlChar" />.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Node.GetAncestor(System.Type)">
- <summary>
- Gets the first ancestor of the specified object type.
- </summary>
- <param name="ancestorType">The object type of the ancestor to retrieve.</param>
- <returns>The ancestor of the specified type or null if no ancestor of this type was found.</returns>
- <remarks>
- <p>The ancestor type matches if it is equal to ancestorType or derived from ancestorType.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Node.GetAncestor(Aspose.Words.NodeType)">
- <summary>
- Gets the first ancestor of the specified <see cref="T:Aspose.Words.NodeType" />.
- </summary>
- <param name="ancestorType">The node type of the ancestor to retrieve.</param>
- <returns>The ancestor of the specified type or null if no ancestor of this type was found.</returns>
- </member>
- <member name="M:Aspose.Words.Node.Remove">
- <summary>
- Removes itself from the parent.
- </summary>
- </member>
- <member name="M:Aspose.Words.Node.NextPreOrder(Aspose.Words.Node)">
- <summary>
- Gets next node according to the pre-order tree traversal algorithm.
- </summary>
- <param name="rootNode">The top node (limit) of traversal.</param>
- <returns>Next node in pre-order order. Null if reached the rootNode.</returns>
- </member>
- <member name="M:Aspose.Words.Node.PreviousPreOrder(Aspose.Words.Node)">
- <summary>
- Gets the previous node according to the pre-order tree traversal algorithm.
- </summary>
- <param name="rootNode">The top node (limit) of traversal.</param>
- <returns>Previous node in pre-order order. Null if reached the rootNode.</returns>
- </member>
- <member name="M:Aspose.Words.Node.ToString(Aspose.Words.SaveFormat)">
- <summary>
- Exports the content of the node into a string in the specified format.
- </summary>
- <returns>The content of the node in the specified format.</returns>
- </member>
- <member name="M:Aspose.Words.Node.ToString(Aspose.Words.Saving.SaveOptions)">
- <summary>
- Exports the content of the node into a string using the specified save options.
- </summary>
- <param name="saveOptions">Specifies the options that control how the node is saved.</param>
- <returns>The content of the node in the specified format.</returns>
- </member>
- <member name="M:Aspose.Words.Node.NodeTypeToString(Aspose.Words.NodeType)">
- <summary>
- A utility method that converts a node type enum value into a user friendly string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Node.NodeType">
- <summary>
- Gets the type of this node.
- </summary>
- </member>
- <member name="P:Aspose.Words.Node.ParentNode">
- <summary>
- Gets the immediate parent of this node.
- </summary>
- <remarks>
- <p>If a node has just been created and not yet added to the tree,
- or if it has been removed from the tree, the parent is null.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Node.Document">
- <summary>
- Gets the document to which this node belongs.
- </summary>
- <remarks>
- <p>The node always belongs to a document even if it has just been created
- and not yet added to the tree, or if it has been removed from the tree.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Node.PreviousSibling">
- <summary>
- Gets the node immediately preceding this node.
- </summary>
- <remarks>
- If there is no preceding node, a null is returned.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Node.NextSibling">
- <summary>
- Gets the node immediately following this node.
- </summary>
- <remarks>
- If there is no next node, a null is returned.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Node.IsComposite">
- <summary>
- Returns true if this node can contain other nodes.
- </summary>
- <value>This method returns false as Node cannot have child nodes.</value>
- </member>
- <member name="P:Aspose.Words.Node.Range">
- <summary>
- Returns a <b>Range</b> object that represents the portion of a document that is contained in this node.
- </summary>
- </member>
- <member name="T:Aspose.Words.NodeChangingAction">
- <summary>
- Specifies the type of node change.
- </summary>
- <seealso cref="T:Aspose.Words.NodeChangingArgs" />
- <seealso cref="P:Aspose.Words.NodeChangingArgs.Action" />
- </member>
- <member name="F:Aspose.Words.NodeChangingAction.Insert">
- <summary>
- A node is being inserted in the tree.
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeChangingAction.Remove">
- <summary>
- A node is being removed from the tree.
- </summary>
- </member>
- <member name="T:Aspose.Words.NodeChangingArgs">
- <summary>
- Provides data for methods of the <see cref="T:Aspose.Words.INodeChangingCallback" /> interface.
-
- <seealso cref="T:Aspose.Words.DocumentBase" /><seealso cref="T:Aspose.Words.INodeChangingCallback" /><seealso cref="T:Aspose.Words.NodeChangingAction" /></summary>
- </member>
- <member name="P:Aspose.Words.NodeChangingArgs.Node">
- <summary>
- Gets the <see cref="P:Aspose.Words.NodeChangingArgs.Node" /> that is being added or removed.
- </summary>
- </member>
- <member name="P:Aspose.Words.NodeChangingArgs.OldParent">
- <summary>
- Gets the node's parent before the operation began.
- </summary>
- </member>
- <member name="P:Aspose.Words.NodeChangingArgs.NewParent">
- <summary>
- Gets the node's parent that will be set after the operation completes.
- </summary>
- </member>
- <member name="P:Aspose.Words.NodeChangingArgs.Action">
- <summary>
- Gets a value indicating what type of node change event is occurring.
- </summary>
- </member>
- <member name="T:Aspose.Words.INodeChangingCallback">
- <summary>
- Implement this interface if you want to receive notifications when nodes are inserted or removed in the document.
- </summary>
- </member>
- <member name="M:Aspose.Words.INodeChangingCallback.NodeInserting(Aspose.Words.NodeChangingArgs)">
- <summary>
- Called just before a node belonging to this document is about to be inserted into another node.
- </summary>
- </member>
- <member name="M:Aspose.Words.INodeChangingCallback.NodeInserted(Aspose.Words.NodeChangingArgs)">
- <summary>
- Called when a node belonging to this document has been inserted into another node.
- </summary>
- </member>
- <member name="M:Aspose.Words.INodeChangingCallback.NodeRemoving(Aspose.Words.NodeChangingArgs)">
- <summary>
- Called just before a node belonging to this document is about to be removed from the document.
- </summary>
- </member>
- <member name="M:Aspose.Words.INodeChangingCallback.NodeRemoved(Aspose.Words.NodeChangingArgs)">
- <summary>
- Called when a node belonging to this document has been removed from its parent.
- </summary>
- </member>
- <member name="T:Aspose.Words.NodeCollection">
- <summary>
- Represents a collection of nodes of a specific type.
- </summary>
- <remarks>
- <p>
- <b>NodeCollection</b> does not own the nodes it contains, rather, is just a selection of nodes
- of the specified type, but the nodes are stored in the tree under their respective parent nodes.</p>
- <p>
- <b>NodeCollection</b> supports indexed access, iteration and provides add and remove methods.</p>
- <p>The <b>NodeCollection</b> collection is "live", i.e. changes to the children of the node object
- that it was created from are immediately reflected in the nodes returned by the <b>NodeCollection</b>
- properties and methods.</p>
- <p>
- <b>NodeCollection</b> is returned by <see cref="M:Aspose.Words.CompositeNode.GetChildNodes(Aspose.Words.NodeType,System.Boolean)" />
- and also serves as a base class for typed node collections such as <see cref="T:Aspose.Words.SectionCollection" />,
- <see cref="T:Aspose.Words.ParagraphCollection" /> etc.</p>
- <p>
- <b>NodeCollection</b> can be "flat" and contain only immediate children of the node it was created
- from, or it can be "deep" and contain all descendant children.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.NodeCollection.Add(Aspose.Words.Node)">
- <summary>
- Adds a node to the end of the collection.
- </summary>
- <remarks>
- <p>The node is inserted as a child into the node object from which the collection was created.</p>
- </remarks>
- <remarks>
- <p>If the newChild is already in the tree, it is first removed.</p>
- <p>If the node being inserted was created from another document, you should use
- <see cref="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)" /> to import the node to the current document.
- The imported node can then be inserted into the current document.</p>
- </remarks>
- <param name="node">The node to be added to the end of the collection.</param>
- <exception cref="T:System.NotSupportedException">The <b>NodeCollection</b> is a "deep" collection.</exception>
- </member>
- <member name="M:Aspose.Words.NodeCollection.Insert(System.Int32,Aspose.Words.Node)">
- <summary>
- Inserts a node into the collection at the specified index.
- </summary>
- <remarks>
- <p>The node is inserted as a child into the node object from which the collection was created.</p>
- <p>If the index is equal to or greater than Count, the node is added at the end of the collection.</p>
- <p>If the index is negative and its absolute value is greater than Count, the node is added at the end of the collection.</p>
- </remarks>
- <remarks>
- <p>If the newChild is already in the tree, it is first removed.</p>
- <p>If the node being inserted was created from another document, you should use
- <see cref="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)" /> to import the node to the current document.
- The imported node can then be inserted into the current document.</p>
- </remarks>
- <param name="index">The zero-based index of the node.
- Negative indexes are allowed and indicate access from the back of the list.
- For example -1 means the last node, -2 means the second before last and so on.</param>
- <param name="node">The node to insert.</param>
- <exception cref="T:System.NotSupportedException">The <b>NodeCollection</b> is a "deep" collection.</exception>
- </member>
- <member name="M:Aspose.Words.NodeCollection.Remove(Aspose.Words.Node)">
- <summary>
- Removes the node from the collection and from the document.
- </summary>
- <param name="node">The node to remove.</param>
- </member>
- <member name="M:Aspose.Words.NodeCollection.RemoveAt(System.Int32)">
- <summary>
- Removes the node at the specified index from the collection and from the document.
- </summary>
- <param name="index">The zero-based index of the node.
- Negative indexes are allowed and indicate access from the back of the list.
- For example -1 means the last node, -2 means the second before last and so on.</param>
- </member>
- <member name="M:Aspose.Words.NodeCollection.Clear">
- <summary>
- Removes all nodes from this collection and from the document.
- </summary>
- </member>
- <member name="M:Aspose.Words.NodeCollection.Contains(Aspose.Words.Node)">
- <summary>
- Determines whether a node is in the collection.
- </summary>
- <remarks>
- <p>This method performs a linear search; therefore, the average execution time is proportional to Count.</p>
- </remarks>
- <param name="node">The node to locate.</param>
- <returns>True if item is found in the collection; otherwise, false.</returns>
- </member>
- <member name="M:Aspose.Words.NodeCollection.IndexOf(Aspose.Words.Node)">
- <summary>
- Returns the zero-based index of the specified node.
- </summary>
- <param name="node">The node to locate.</param>
- <returns>The zero-based index of the node within the collection, if found; otherwise, -1.</returns>
- <remarks>
- <p>This method performs a linear search; therefore, the average execution time is proportional to Count.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.NodeCollection.ToArray">
- <summary>
- Copies all nodes from the collection to a new array of nodes.
- </summary>
- <remarks>
- <p>You should not be adding/removing nodes while iterating over a collection
- of nodes because it invalidates the iterator and requires refreshes for live collections.</p>
- <p>To be able to add/remove nodes during iteration, use this method to copy
- nodes into a fixed-size array and then iterate over the array.</p>
- </remarks>
- <returns>An array of nodes.</returns>
- </member>
- <member name="M:Aspose.Words.NodeCollection.GetEnumerator">
- <summary>
- Provides a simple "foreach" style iteration over the collection of nodes.
- </summary>
- <returns>An IEnumerator.</returns>
- </member>
- <member name="P:Aspose.Words.NodeCollection.Item(System.Int32)">
- <summary>
- Retrieves a node at the given index.
- </summary>
- <param name="index">An index into the collection of nodes.</param>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.NodeCollection.Count">
- <summary>
- Gets the number of nodes in the collection.
- </summary>
- </member>
- <member name="T:Aspose.Words.NodeList">
- <summary>
- Represents a collection of nodes matching an XPath query executed using the <see cref="M:Aspose.Words.CompositeNode.SelectNodes(System.String)" /> method.
- </summary>
- <remarks>
- <p>
- <b>NodeList</b> is returned by <see cref="M:Aspose.Words.CompositeNode.SelectNodes(System.String)" /> and contains a collection
- of nodes matching the XPath query.</p>
- <p>
- <b>NodeList</b> supports indexed access and iteration.</p>
- <note>Treat the <b>NodeList</b> collection as a "snapshot" collection. <b>NodeList</b> starts
- as a "live" collection because the nodes are not actually retrieved when the XPath query is run.
- The nodes are only retrieved upon access and at this time the node and all nodes that precede
- it are cached forming a "snapshot" collection.</note>
- </remarks>
- </member>
- <member name="M:Aspose.Words.NodeList.ToArray">
- <summary>
- Copies all nodes from the collection to a new array of nodes.
- </summary>
- <remarks>
- <p>You should not be adding/removing nodes while iterating over a collection
- of nodes because it invalidates the iterator and requires refreshes for live collections.</p>
- <p>To be able to add/remove nodes during iteration, use this method to copy
- nodes into a fixed-size array and then iterate over the array.</p>
- </remarks>
- <returns>An array of nodes.</returns>
- </member>
- <member name="M:Aspose.Words.NodeList.GetEnumerator">
- <summary>
- Provides a simple "foreach" style iteration over the collection of nodes.
- </summary>
- <returns>An IEnumerator.</returns>
- </member>
- <member name="P:Aspose.Words.NodeList.Item(System.Int32)">
- <summary>
- Retrieves a node at the given index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the list of nodes.</param>
- </member>
- <member name="P:Aspose.Words.NodeList.Count">
- <summary>
- Gets the number of nodes in the list.
- </summary>
- </member>
- <member name="T:Aspose.Words.NodeType">
- <summary>
- Specifies the type of a Word document node.
- </summary>
- <dev>
- <p>Enumerated node types are provided as a common denominator to ensure all functionality
- is accessible to all clients (including COM applications that might not have full access
- to the runtime type information).</p>
- </dev>
- </member>
- <member name="F:Aspose.Words.NodeType.Any">
- <summary>
- Indicates all node types. Allows to select all children.
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.Document">
- <summary>
- <p>A <see cref="T:Aspose.Words.Document" /> object that, as the root of the document tree,
- provides access to the entire Word document.</p>
- <p>A <see cref="T:Aspose.Words.Document" /> node can have <see cref="T:Aspose.Words.Section" /> nodes.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.Section">
- <summary>
- <p>A <see cref="T:Aspose.Words.Section" /> object that corresponds to one section in a Word document.</p>
- <p>A <see cref="T:Aspose.Words.Section" /> node can have <b>Body</b> and <b>HeaderFooter</b> nodes.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.Body">
- <summary>
- <p>A <see cref="T:Aspose.Words.Body" /> object that contains the main text of a section (main text story).</p>
- <p>A <see cref="T:Aspose.Words.Body" /> node can have <see cref="T:Aspose.Words.Paragraph" /> and <see cref="T:Aspose.Words.Tables.Table" /> nodes.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.HeaderFooter">
- <summary>
- <p>A <see cref="T:Aspose.Words.HeaderFooter" /> object that contains text of a particular header or footer inside a section.</p>
- <p>A <see cref="T:Aspose.Words.HeaderFooter" /> node can have <see cref="T:Aspose.Words.Paragraph" /> and <see cref="T:Aspose.Words.Tables.Table" /> nodes.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.Table">
- <summary>
- <p>A <see cref="T:Aspose.Words.Tables.Table" /> object that represents a table in a Word document.</p>
- <p>A <see cref="T:Aspose.Words.Tables.Table" /> node can have <see cref="T:Aspose.Words.Tables.Row" /> nodes.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.Row">
- <summary>
- <p>A row of a table.</p>
- <p>A <see cref="T:Aspose.Words.Tables.Row" /> node can have <see cref="T:Aspose.Words.Tables.Cell" /> nodes.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.Cell">
- <summary>
- <p>A cell of a table row.</p>
- <p>A <see cref="T:Aspose.Words.Tables.Cell" /> node can have <see cref="T:Aspose.Words.Paragraph" /> and <see cref="T:Aspose.Words.Tables.Table" /> nodes.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.Paragraph">
- <summary>
- <p>A paragraph of text.</p>
- <p>A <see cref="T:Aspose.Words.Paragraph" /> node is a container for inline level elements
- <see cref="T:Aspose.Words.Run" />,
- <see cref="T:Aspose.Words.Fields.FieldStart" />,
- <see cref="T:Aspose.Words.Fields.FieldSeparator" />,
- <see cref="T:Aspose.Words.Fields.FieldEnd" />,
- <see cref="T:Aspose.Words.Fields.FormField" />,
- <see cref="T:Aspose.Words.Drawing.Shape" />,
- <see cref="T:Aspose.Words.Drawing.GroupShape" />,
- <see cref="T:Aspose.Words.Footnote" />,
- <see cref="T:Aspose.Words.Comment" />,
- <see cref="T:Aspose.Words.SpecialChar" />,
- as well as <see cref="T:Aspose.Words.BookmarkStart" /> and <see cref="T:Aspose.Words.BookmarkEnd" />.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.BookmarkStart">
- <summary>
- <p>A beginning of a bookmark marker.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.BookmarkEnd">
- <summary>
- <p>An end of a bookmark marker.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.EditableRangeStart">
- <summary>
- <p>A beginning of an editable range.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.EditableRangeEnd">
- <summary>
- <p>An end of an editable range.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.MoveFromRangeStart">
- <summary>
- <p>A beginning of an MoveFrom range.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.MoveFromRangeEnd">
- <summary>
- <p>An end of an MoveFrom range.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.MoveToRangeStart">
- <summary>
- <p>A beginning of an MoveTo range.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.MoveToRangeEnd">
- <summary>
- <p>An end of an MoveTo range.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.GroupShape">
- <summary>
- <p>A group of shapes, images, OLE objects or other group shapes.</p>
- <p>A <see cref="T:Aspose.Words.Drawing.GroupShape" /> node can contain other
- <see cref="T:Aspose.Words.Drawing.Shape" /> and <see cref="T:Aspose.Words.Drawing.GroupShape" /> nodes.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.Shape">
- <summary>
- <p>A drawing object, such as an OfficeArt shape, image or an OLE object.</p>
- <p>A <see cref="T:Aspose.Words.Drawing.Shape" /> node can contain <see cref="T:Aspose.Words.Paragraph" />
- and <see cref="T:Aspose.Words.Tables.Table" /> nodes.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.Comment">
- <summary>
- <p>A comment in a Word document.</p>
- <p>A <see cref="T:Aspose.Words.Comment" /> node can have <see cref="T:Aspose.Words.Paragraph" /> and <see cref="T:Aspose.Words.Tables.Table" /> nodes.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.Footnote">
- <summary>
- <p>A footnote or endnote in a Word document.</p>
- <p>A <see cref="T:Aspose.Words.Footnote" /> node can have <see cref="T:Aspose.Words.Paragraph" /> and <see cref="T:Aspose.Words.Tables.Table" /> nodes.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.Run">
- <summary>
- <p>A run of text.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.FieldStart">
- <summary>
- <p>A special character that designates the start of a Word field.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.FieldSeparator">
- <summary>
- <p>A special character that separates the field code from the field result.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.FieldEnd">
- <summary>
- <p>A special character that designates the end of a Word field.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.FormField">
- <summary>
- <p>A form field.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.SpecialChar">
- <summary>
- <p>A special character that is not one of the more specific special character types.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.SmartTag">
- <summary>
- <para>A smart tag around one or more inline structures (runs, images, fields,etc.) within a paragraph</para>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.StructuredDocumentTag">
- <summary>
- <para>Allows to define customer-specific information and its means of presentation.</para>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.StructuredDocumentTagRangeStart">
- <summary>
- <para>A start of <b>ranged</b> structured document tag which accepts multi-sections content.</para>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.StructuredDocumentTagRangeEnd">
- <summary>
- <para>A end of <b>ranged</b> structured document tag which accepts multi-sections content.</para>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.GlossaryDocument">
- <summary>
- <para>A glossary document within the main document.</para>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.BuildingBlock">
- <summary>
- <para>A building block within a glossary document (e.g. glossary document entry).</para>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.CommentRangeStart">
- <summary>
- A marker node that represents the start of a commented range.
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.CommentRangeEnd">
- <summary>
- A marker node that represents the end of a commented range.
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.OfficeMath">
- <summary>
- <para> An Office Math object. Can be equation, function, matrix or one of other mathematical objects.
- Can be a collection of mathematical object and also can contain some non-mathematical objects such as runs of text.</para>
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.SubDocument">
- <summary>
- A subdocument node which is a link to another document.
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.System">
- <summary>
- Reserved for internal use by Aspose.Words.
- </summary>
- </member>
- <member name="F:Aspose.Words.NodeType.Null">
- <summary>
- Reserved for internal use by Aspose.Words.
- </summary>
- </member>
- <member name="T:Aspose.Words.CommentRangeEnd">
- <summary>
- Denotes the end of a region of text that has a comment associated with it.
- </summary>
- <remarks>
- <para>To create a comment anchored to a region of text, you need to create a <see cref="T:Aspose.Words.Comment" /> and
- then create <see cref="T:Aspose.Words.CommentRangeStart" /> and <see cref="T:Aspose.Words.CommentRangeEnd" /> and set their identifiers
- to the same <see cref="P:Aspose.Words.Comment.Id" /> value.</para>
- <p>
- <see cref="T:Aspose.Words.CommentRangeEnd" /> is an inline-level node and can only be a child of <see cref="T:Aspose.Words.Paragraph" />.</p>
- <seealso cref="T:Aspose.Words.Comment" />
- <seealso cref="T:Aspose.Words.CommentRangeStart" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.CommentRangeEnd.#ctor(Aspose.Words.DocumentBase,System.Int32)">
- <summary>
- Initializes a new instance of this class.
- </summary>
- <remarks>
- <p>When <see cref="T:Aspose.Words.CommentRangeEnd" /> is created, it belongs to the specified document, but is not
- yet part of the document and <see cref="P:Aspose.Words.Node.ParentNode" /> is null.</p>
- <p>To append a <see cref="T:Aspose.Words.CommentRangeEnd" /> to the document use InsertAfter or InsertBefore
- on the paragraph where you want the comment inserted.</p>
- </remarks>
- <param name="doc">The owner document.</param>
- <param name="id">The comment identifier to which this object is linked.</param>
- </member>
- <member name="M:Aspose.Words.CommentRangeEnd.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitCommentRangeEnd(Aspose.Words.CommentRangeEnd)" />.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the node.</param>
- <returns>False if the visitor requested the enumeration to stop.</returns>
- </member>
- <member name="P:Aspose.Words.CommentRangeEnd.Id">
- <summary>
- Specifies the identifier of the comment to which this region is linked to.
- </summary>
- </member>
- <member name="P:Aspose.Words.CommentRangeEnd.NodeType">
- <summary>
- Returns <see cref="F:Aspose.Words.NodeType.CommentRangeEnd" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.CommentRangeStart">
- <summary>
- Denotes the start of a region of text that has a comment associated with it.
- </summary>
- <remarks>
- <para>To create a comment anchored to a region of text, you need to create a <see cref="T:Aspose.Words.Comment" /> and
- then create <see cref="T:Aspose.Words.CommentRangeStart" /> and <see cref="T:Aspose.Words.CommentRangeEnd" /> and set their identifiers
- to the same <see cref="P:Aspose.Words.Comment.Id" /> value.</para>
- <p>
- <see cref="T:Aspose.Words.CommentRangeStart" /> is an inline-level node and can only be a child of <see cref="T:Aspose.Words.Paragraph" />.</p>
- <seealso cref="T:Aspose.Words.Comment" />
- <seealso cref="T:Aspose.Words.CommentRangeEnd" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.CommentRangeStart.#ctor(Aspose.Words.DocumentBase,System.Int32)">
- <summary>
- Initializes a new instance of this class.
- </summary>
- <remarks>
- <p>When <see cref="T:Aspose.Words.CommentRangeStart" /> is created, it belongs to the specified document, but is not
- yet part of the document and <see cref="P:Aspose.Words.Node.ParentNode" /> is null.</p>
- <p>To append a <see cref="T:Aspose.Words.CommentRangeStart" /> to the document use InsertAfter or InsertBefore
- on the paragraph where you want the comment inserted.</p>
- </remarks>
- <param name="doc">The owner document.</param>
- <param name="id">The comment identifier to which this object is linked.</param>
- </member>
- <member name="M:Aspose.Words.CommentRangeStart.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitCommentRangeStart(Aspose.Words.CommentRangeStart)" />.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the node.</param>
- <returns>False if the visitor requested the enumeration to stop.</returns>
- </member>
- <member name="P:Aspose.Words.CommentRangeStart.Id">
- <summary>
- Specifies the identifier of the comment to which this region is linked.
- </summary>
- </member>
- <member name="P:Aspose.Words.CommentRangeStart.NodeType">
- <summary>
- Returns <see cref="F:Aspose.Words.NodeType.CommentRangeStart" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.EmphasisMark">
- <summary>
- Specifies possible types of emphasis mark.
- </summary>
- <dev>
- Names borrowed from https://docs.microsoft.com/en-us/dotnet/api/microsoft.office.interop.word.wdemphasismark?view=word-pia
- </dev>
- </member>
- <member name="F:Aspose.Words.EmphasisMark.None">
- <summary>
- No emphasis mark.
- </summary>
- </member>
- <member name="F:Aspose.Words.EmphasisMark.OverSolidCircle">
- <summary>
- Emphasis mark is a solid black circle displayed above text.
- </summary>
- </member>
- <member name="F:Aspose.Words.EmphasisMark.OverComma">
- <summary>
- Emphasis mark is a comma character displayed above text.
- </summary>
- </member>
- <member name="F:Aspose.Words.EmphasisMark.OverWhiteCircle">
- <summary>
- Emphasis mark is an empty white circle displayed above text.
- </summary>
- </member>
- <member name="F:Aspose.Words.EmphasisMark.UnderSolidCircle">
- <summary>
- Emphasis mark is a solid black circle displayed below text.
- </summary>
- </member>
- <member name="T:Aspose.Words.DocumentBase">
- <summary>
- Provides the abstract base class for a main document and a glossary document of a Word document.
- </summary>
- <remarks>
- <para>Aspose.Words represents a Word document as a tree of nodes. <see cref="T:Aspose.Words.DocumentBase" /> is a
- root node of the tree that contains all other nodes of the document.</para>
- <para>
- <see cref="T:Aspose.Words.DocumentBase" /> also stores document-wide information such as <see cref="P:Aspose.Words.DocumentBase.Styles" /> and
- <see cref="P:Aspose.Words.DocumentBase.Lists" /> that the tree nodes might refer to.</para>
- <seealso cref="T:Aspose.Words.Document" />
- <seealso cref="T:Aspose.Words.DocumentBase" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean)">
- <overloads>Imports a node from another document to the current document.</overloads>
- <summary>
- <p>Imports a node from another document to the current document.</p>
- </summary>
- <remarks>
- <p>This method uses the <see cref="F:Aspose.Words.ImportFormatMode.UseDestinationStyles" /> option to resolve formatting.</p>
- <p>Importing a node creates a copy of the source node belonging to the importing document.
- The returned node has no parent. The source node is not altered or removed from the original document.</p>
- <p>Before a node from another document can be inserted into this document, it must be imported.
- During import, document-specific properties such as references to styles and lists are translated
- from the original to the importing document. After the node was imported, it can be inserted
- into the appropriate place in the document using <see cref="M:Aspose.Words.CompositeNode.InsertBefore(Aspose.Words.Node,Aspose.Words.Node)" /> or
- <see cref="M:Aspose.Words.CompositeNode.InsertAfter(Aspose.Words.Node,Aspose.Words.Node)" />.</p>
- <p>If the source node already belongs to the destination document, then simply a deep clone
- of the source node is created.</p>
- <seealso cref="T:Aspose.Words.NodeImporter" />
- </remarks>
- <param name="srcNode">The node being imported.</param>
- <param name="isImportChildren">True to import all child nodes recursively; otherwise, false.</param>
- <returns>The cloned node that belongs to the current document.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.INodeCloningListener)">
- <summary>
- <p>Imports a node from another document to the current document.</p>
- </summary>
- <remarks>
- <p>This method uses the <see cref="F:Aspose.Words.ImportFormatMode.UseDestinationStyles" /> option to resolve formatting.</p>
- <p>Importing a node creates a copy of the source node belonging to the importing document.
- The returned node has no parent. The source node is not altered or removed from the original document.</p>
- <p>Before a node from another document can be inserted into this document, it must be imported.
- During import, document-specific properties such as references to styles and lists are translated
- from the original to the importing document. After the node was imported, it can be inserted
- into the appropriate place in the document using <see cref="M:Aspose.Words.CompositeNode.InsertBefore(Aspose.Words.Node,Aspose.Words.Node)" /> or
- <see cref="M:Aspose.Words.CompositeNode.InsertAfter(Aspose.Words.Node,Aspose.Words.Node)" />.</p>
- <p>If the source node already belongs to the destination document, then simply a deep clone
- of the source node is created.</p>
- <seealso cref="T:Aspose.Words.NodeImporter" />
- </remarks>
- <param name="srcNode">The node being imported.</param>
- <param name="isImportChildren">True to import all child nodes recursively; otherwise, false.</param>
- <param name="cloningListener">The listener to the node cloning events.</param>
- <returns>The cloned node that belongs to the current document.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)">
- <summary>
- <p>Imports a node from another document to the current document with an option to control formatting.</p>
- </summary>
- <remarks>
- <p>This overload is useful to control how styles and list formatting are imported.</p>
- <p>Importing a node creates a copy of the source node belonging to the importing document.
- The returned node has no parent. The source node is not altered or removed from the original document.</p>
- <p>Before a node from another document can be inserted into this document, it must be imported.
- During import, document-specific properties such as references to styles and lists are translated
- from the original to the importing document. After the node was imported, it can be inserted
- into the appropriate place in the document using <see cref="M:Aspose.Words.CompositeNode.InsertBefore(Aspose.Words.Node,Aspose.Words.Node)" /> or
- <see cref="M:Aspose.Words.CompositeNode.InsertAfter(Aspose.Words.Node,Aspose.Words.Node)" />.</p>
- <p>If the source node already belongs to the destination document, then simply a deep clone
- of the source node is created.</p>
- <seealso cref="T:Aspose.Words.ImportFormatMode" />
- <seealso cref="T:Aspose.Words.NodeImporter" />
- </remarks>
- <param name="srcNode">The node to imported.</param>
- <param name="isImportChildren">True to import all child nodes recursively; otherwise, false.</param>
- <param name="importFormatMode">Specifies how to merge style formatting that clashes.</param>
- <returns>The cloned, imported node. The node belongs to the destination document, but has no parent.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode,Aspose.Words.INodeCloningListener)">
- <summary>
- <p>Imports a node from another document to the current document with an option to control formatting.</p>
- </summary>
- <remarks>
- <p>Importing a node creates a copy of the source node belonging to the importing document.
- The returned node has no parent. The source node is not altered or removed from the original document.</p>
- <p>Before a node from another document can be inserted into this document, it must be imported.
- During import, document-specific properties such as references to styles and lists are translated
- from the original to the importing document. After the node was imported, it can be inserted
- into the appropriate place in the document using <see cref="M:Aspose.Words.CompositeNode.InsertBefore(Aspose.Words.Node,Aspose.Words.Node)" /> or
- <see cref="M:Aspose.Words.CompositeNode.InsertAfter(Aspose.Words.Node,Aspose.Words.Node)" />.</p>
- <p>If the source node already belongs to the destination document, then simply a deep clone
- of the source node is created.</p>
- <seealso cref="T:Aspose.Words.ImportFormatMode" />
- <seealso cref="T:Aspose.Words.NodeImporter" />
- </remarks>
- <param name="srcNode">The node to imported.</param>
- <param name="isImportChildren">True to import all child nodes recursively; otherwise, false.</param>
- <param name="importFormatMode">Specifies how to merge style formatting that clashes.</param>
- <param name="cloningListener">The listener to the node cloning events.</param>
- <returns>The cloned, imported node. The node belongs to the destination document, but has no parent.</returns>
- </member>
- <member name="P:Aspose.Words.DocumentBase.NodeChangingCallback">
- <summary>
- Called when a node is inserted or removed in the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBase.ResourceLoadingCallback">
- <summary>
- Allows to control how external resources are loaded.
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBase.FontInfos">
- <summary>
- Provides access to properties of fonts used in this document.
- </summary>
- <remarks>
- <para>This collection of font definitions is loaded as is from the document.
- Font definitions might be optional, missing or incomplete in some documents.</para>
- <para>Do not rely on this collection to ascertain that a particular font is used in the document.
- You should only use this collection to get information about fonts that might be used in the document.</para>
- <seealso cref="T:Aspose.Words.Fonts.FontInfoCollection" />
- <seealso cref="T:Aspose.Words.Fonts.FontInfo" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.DocumentBase.Styles">
- <summary>
- Returns a collection of styles defined in the document.
- </summary>
- <remarks>
- <p>For more information see the description of the <see cref="T:Aspose.Words.StyleCollection" /> class.</p>
- <seealso cref="T:Aspose.Words.StyleCollection" />
- <seealso cref="T:Aspose.Words.Style" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.DocumentBase.Lists">
- <summary>
- Provides access to the list formatting used in the document.
- </summary>
- <remarks>
- <p>For more information see the description of the <see cref="T:Aspose.Words.Lists.ListCollection" /> class.</p>
- <seealso cref="T:Aspose.Words.Lists.ListCollection" />
- <seealso cref="T:Aspose.Words.Lists.List" />
- <seealso cref="T:Aspose.Words.ListFormat" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.DocumentBase.WarningCallback">
- <summary>
- Called during various document processing procedures when an issue is detected that might result
- in data or formatting fidelity loss.
- </summary>
- <remarks>
- Document may generate warnings at any stage of its existence, so it's important to setup warning callback as
- early as possible to avoid the warnings loss. E.g. such properties as <see cref="P:Aspose.Words.Document.PageCount" />
- actually build the document layout which is used later for rendering, and the layout warnings may be lost if
- warning callback is specified just for the rendering calls later.
- </remarks>
- </member>
- <member name="P:Aspose.Words.DocumentBase.BackgroundShape">
- <summary>
- Gets or sets the background shape of the document. Can be null.
- </summary>
- <remarks>
- <para>Microsoft Word allows only a shape that has its <see cref="P:Aspose.Words.Drawing.ShapeBase.ShapeType" /> property equal
- to <see cref="F:Aspose.Words.Drawing.ShapeType.Rectangle" /> to be used as a background shape for a document.</para>
- <para>Microsoft Word supports only the fill properties of a background shape. All other properties
- are ignored.</para>
- <para>Setting this property to a non-null value will also set the <see cref="P:Aspose.Words.Settings.ViewOptions.DisplayBackgroundShape" /> to true.</para>
- <seealso cref="P:Aspose.Words.Settings.ViewOptions.DisplayBackgroundShape" />
- <seealso cref="P:Aspose.Words.DocumentBase.PageColor" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.DocumentBase.PageColor">
- <summary>
- Gets or sets the page color of the document. This property is a simpler version of <see cref="P:Aspose.Words.DocumentBase.BackgroundShape" />.
- </summary>
- <remarks>
- <para>This property provides a simple way to specify a solid page color for the document.
- Setting this property creates and sets an appropriate <see cref="P:Aspose.Words.DocumentBase.BackgroundShape" />.</para>
- <para>If the page color is not set (e.g. there is no background shape in the document) returns
- <see cref="F:System.Drawing.Color.Empty" />.</para>
- <seealso cref="P:Aspose.Words.DocumentBase.BackgroundShape" />
- </remarks>
- </member>
- <member name="T:Aspose.Words.TableStyle">
- <summary>
- Represents a table style.
- </summary>
- <dev>
- It is interesting to note that all attribute collections in the style are not supposed
- to contain attributes that reference another style. E.g. TablePr of the style should not
- contain Istd of a table style. It is actually a good thing. The only problem is that we
- do not validate it and maybe reading from some formats could leave Istd in these collections.
- </dev>
- </member>
- <member name="P:Aspose.Words.TableStyle.AllowBreakAcrossPages">
- <summary>
- Gets or sets a flag indicating whether text in a table row is allowed to split across a page break.
- </summary>
- <remarks>
- The default value is <b>true</b>.
- </remarks>
- </member>
- <member name="P:Aspose.Words.TableStyle.Borders">
- <summary>
- Gets the collection of default cell borders for the style.
- </summary>
- </member>
- <member name="P:Aspose.Words.TableStyle.LeftPadding">
- <summary>
- Gets or sets the amount of space (in points) to add to the left of the contents of table cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.TableStyle.RightPadding">
- <summary>
- Gets or sets the amount of space (in points) to add to the right of the contents of table cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.TableStyle.TopPadding">
- <summary>
- Gets or sets the amount of space (in points) to add above the contents of table cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.TableStyle.BottomPadding">
- <summary>
- Gets or sets the amount of space (in points) to add below the contents of table cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.TableStyle.Alignment">
- <summary>
- Specifies the alignment for the table style.
- </summary>
- <remarks>
- The default value is <see cref="F:Aspose.Words.Tables.TableAlignment.Left" />.
- </remarks>
- </member>
- <member name="P:Aspose.Words.TableStyle.CellSpacing">
- <summary>
- Gets or sets the amount of space (in points) between the cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.TableStyle.Bidi">
- <summary>
- Gets or sets whether this is a style for a right-to-left table.
- </summary>
- <remarks>
- <para>When <b>true</b>, the cells in rows are laid out right to left.</para>
- <para>The default value is <b>false</b>.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.TableStyle.LeftIndent">
- <summary>
- Gets or sets the value that represents the left indent of a table.
- </summary>
- </member>
- <member name="P:Aspose.Words.TableStyle.Shading">
- <summary>
- Gets a <see cref="T:Aspose.Words.Shading" /> object that refers to the shading formatting for table cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.TableStyle.RowStripe">
- <summary>
- Gets or sets a number of rows to include in the banding when the style specifies odd/even row banding.
- </summary>
- </member>
- <member name="P:Aspose.Words.TableStyle.ColumnStripe">
- <summary>
- Gets or sets a number of columns to include in the banding when the style specifies odd/even columns banding.
- </summary>
- </member>
- <member name="P:Aspose.Words.TableStyle.ConditionalStyles">
- <summary>
- Collection of conditional styles that may be defined for this table style.
- </summary>
- </member>
- <member name="T:Aspose.Words.ConditionalStyle">
- <summary>
- Represents special formatting applied to some area of a table with assigned table style.
- </summary>
- </member>
- <member name="M:Aspose.Words.ConditionalStyle.ClearFormatting">
- <summary>
- Clears formatting of this conditional style.
- </summary>
- </member>
- <member name="M:Aspose.Words.ConditionalStyle.Equals(Aspose.Words.ConditionalStyle)">
- <summary>
- Compares this conditional style with the specified one.
- </summary>
- </member>
- <member name="M:Aspose.Words.ConditionalStyle.GetHashCode">
- <summary>
- Calculates hash code for this object.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyle.ParagraphFormat">
- <summary>
- Gets the paragraph formatting of the conditional style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyle.Font">
- <summary>
- Gets the character formatting of the conditional style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyle.Shading">
- <summary>
- Gets a <see cref="T:Aspose.Words.Shading" /> object that refers to the shading formatting for this conditional style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyle.Borders">
- <summary>
- Gets the collection of default cell borders for the conditional style.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyle.LeftPadding">
- <summary>
- Gets or sets the amount of space (in points) to add to the left of the contents of table cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyle.RightPadding">
- <summary>
- Gets or sets the amount of space (in points) to add to the right of the contents of table cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyle.TopPadding">
- <summary>
- Gets or sets the amount of space (in points) to add above the contents of table cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyle.BottomPadding">
- <summary>
- Gets or sets the amount of space (in points) to add below the contents of table cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.ConditionalStyle.Type">
- <summary>
- Gets table area to which this conditional style relates.
- </summary>
- </member>
- <member name="T:Aspose.Words.BreakType">
- <summary>
- Specifies type of a break inside a document.
- </summary>
- </member>
- <member name="F:Aspose.Words.BreakType.ParagraphBreak">
- <summary>
- Break between paragraphs.
- </summary>
- </member>
- <member name="F:Aspose.Words.BreakType.PageBreak">
- <summary>
- Explicit page break.
- </summary>
- </member>
- <member name="F:Aspose.Words.BreakType.ColumnBreak">
- <summary>
- Explicit column break.
- </summary>
- </member>
- <member name="F:Aspose.Words.BreakType.SectionBreakContinuous">
- <summary>
- Specifies start of new section on the same page as the previous section.
- </summary>
- </member>
- <member name="F:Aspose.Words.BreakType.SectionBreakNewColumn">
- <summary>
- Specifies start of new section in the new column.
- </summary>
- </member>
- <member name="F:Aspose.Words.BreakType.SectionBreakNewPage">
- <summary>
- Specifies start of new section on a new page.
- </summary>
- </member>
- <member name="F:Aspose.Words.BreakType.SectionBreakEvenPage">
- <summary>
- Specifies start of new section on a new even page.
- </summary>
- </member>
- <member name="F:Aspose.Words.BreakType.SectionBreakOddPage">
- <summary>
- Specifies start of new section on a odd page.
- </summary>
- </member>
- <member name="F:Aspose.Words.BreakType.LineBreak">
- <summary>
- Explicit line break.
- </summary>
- </member>
- <member name="T:Aspose.Words.Document">
- <summary>
- Represents a Word document.
- </summary>
- <remarks>
- <p>The <b>Document</b> is a central object in the Aspose.Words library.</p>
- <p>To load an existing document in any of the <see cref="T:Aspose.Words.LoadFormat" /> formats, pass a file name
- or a stream into one of the <b>Document</b> constructors. To create a blank document, call the
- constructor without parameters.</p>
- <p>Use one of the Save method overloads to save the document in any of the
- <see cref="T:Aspose.Words.SaveFormat" /> formats.</p>
- <para>To draw document pages directly onto a <b>Graphics</b> object use
- <see cref="M:Aspose.Words.Document.RenderToScale(System.Int32,System.Drawing.Graphics,System.Single,System.Single,System.Single)" /> or <see cref="M:Aspose.Words.Document.RenderToSize(System.Int32,System.Drawing.Graphics,System.Single,System.Single,System.Single,System.Single)" /> method.</para>
- <para>To print the document, use one of the <see cref="M:Aspose.Words.Document.Print(System.String)" /> methods.</para>
- <p>
- <see cref="P:Aspose.Words.Document.MailMerge" /> is the Aspose.Words's reporting engine that allows to populate
- reports designed in Microsoft Word with data from various data sources quickly and easily.
- The data can be from a DataSet, DataTable, DataView, IDataReader or an array of values.
- <b>MailMerge</b> will go through the records found in the data source and insert them into
- mail merge fields in the document growing it as necessary.</p>
- <p>
- <b>Document</b> stores document-wide information such as <see cref="P:Aspose.Words.DocumentBase.Styles" />,
- <see cref="P:Aspose.Words.Document.BuiltInDocumentProperties" />, <see cref="P:Aspose.Words.Document.CustomDocumentProperties" />, lists and macros.
- Most of these objects are accessible via the corresponding properties of the <b>Document</b>.</p>
- <p>The <b>Document</b> is a root node of a tree that contains all other nodes of the document.
- The tree is a Composite design pattern and in many ways similar to XmlDocument.
- The content of the document can be manipulated freely programmatically:</p>
- <list type="bullet">
- <item>The nodes of the document can be accessed via typed collections, for example <see cref="P:Aspose.Words.Document.Sections" />,
- <see cref="T:Aspose.Words.ParagraphCollection" /> etc.</item>
- <item>The nodes of the document can be selected by their node type using
- <see cref="M:Aspose.Words.CompositeNode.GetChildNodes(Aspose.Words.NodeType,System.Boolean)" />
- or using an XPath query with <see cref="M:Aspose.Words.CompositeNode.SelectNodes(System.String)" /> or <see cref="M:Aspose.Words.CompositeNode.SelectSingleNode(System.String)" />.</item>
- <item>Content nodes can be added or removed from anywhere in the document using
- <see cref="M:Aspose.Words.CompositeNode.InsertBefore(Aspose.Words.Node,Aspose.Words.Node)" />, <see cref="M:Aspose.Words.CompositeNode.InsertAfter(Aspose.Words.Node,Aspose.Words.Node)" />,
- <see cref="M:Aspose.Words.CompositeNode.RemoveChild(Aspose.Words.Node)" /> and other
- methods provided by the base class <see cref="T:Aspose.Words.CompositeNode" />.</item>
- <item>The formatting attributes of each node can be changed via the properties of that node.</item>
- </list>
- <p>Consider using <see cref="T:Aspose.Words.DocumentBuilder" /> that simplifies the task of programmatically creating
- or populating the document tree.</p>
- <p>The <b>Document</b> can contain only <see cref="T:Aspose.Words.Section" /> objects.</p>
- <p>In Microsoft Word, a valid document needs to have at least one section.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Document.#ctor(System.Boolean)">
- <summary>
- Ctor that allows to create a completely empty document node or load a blank document.
- </summary>
- </member>
- <member name="M:Aspose.Words.Document.#ctor(System.IO.Stream,Aspose.Words.LoadOptions,System.Boolean)">
- <summary>
- Opens an existing document from a stream.
- This ctor for internal use only, it is forbidden to use public ctors inside code to avoid extra credit billings.
- </summary>
- <param name="stream">Stream where to load the document from.</param>
- <param name="loadOptions">Additional options to use when loading a document. Can be null.</param>
- <param name="increaseCredit">Increase credit if it is needed (for example when PlainTextDocument document is created)</param>
- </member>
- <member name="M:Aspose.Words.Document.#ctor">
- <overloads>Creates or loads a document.</overloads>
- <summary>
- Creates a blank Word document.
- </summary>
- <remarks>
- <p>The document paper size is Letter by default. If you want to change page setup, use
- <see cref="P:Aspose.Words.Section.PageSetup">Section.PageSetup</see>.</p>
- <p>After creation, you can use <see cref="T:Aspose.Words.DocumentBuilder" /> to add document content easily.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Document.#ctor(System.String)">
- <summary>
- Opens an existing document from a file. Automatically detects the file format.
- </summary>
- <param name="fileName">File name of the document to open.</param>
- <exception cref="T:Aspose.Words.UnsupportedFileFormatException">The document format is not recognized or not supported.</exception>
- <exception cref="T:Aspose.Words.FileCorruptedException">The document appears to be corrupted and cannot be loaded.</exception>
- <exception cref="T:System.Exception">There is a problem with the document and it should be reported to Aspose.Words developers.</exception>
- <exception cref="T:System.IO.IOException">There is an input/output exception.</exception>
- <exception cref="T:Aspose.Words.IncorrectPasswordException">The document is encrypted and requires a password to open, but you supplied an incorrect password.</exception>
- <exception cref="T:System.ArgumentException">The name of the file cannot be null or empty string.</exception>
- </member>
- <member name="M:Aspose.Words.Document.#ctor(System.String,Aspose.Words.LoadOptions)">
- <summary>
- Opens an existing document from a file. Allows to specify additional options such as an encryption password.
- </summary>
- <param name="fileName">File name of the document to open.</param>
- <param name="loadOptions">Additional options to use when loading a document. Can be null.</param>
- <exception cref="T:Aspose.Words.UnsupportedFileFormatException">The document format is not recognized or not supported.</exception>
- <exception cref="T:Aspose.Words.FileCorruptedException">The document appears to be corrupted and cannot be loaded.</exception>
- <exception cref="T:System.Exception">There is a problem with the document and it should be reported to Aspose.Words developers.</exception>
- <exception cref="T:System.IO.IOException">There is an input/output exception.</exception>
- <exception cref="T:Aspose.Words.IncorrectPasswordException">The document is encrypted and requires a password to open, but you supplied an incorrect password.</exception>
- <exception cref="T:System.ArgumentException">The name of the file cannot be null or empty string.</exception>
- </member>
- <member name="M:Aspose.Words.Document.#ctor(System.IO.Stream)">
- <summary>
- Opens an existing document from a stream. Automatically detects the file format.
- </summary>
- <remarks>
- <p>
- The document must be stored at the beginning of the stream. The stream must support random positioning.</p>
- </remarks>W
- <param name="stream">Stream where to load the document from.</param><exception cref="T:Aspose.Words.UnsupportedFileFormatException">The document format is not recognized or not supported.</exception><exception cref="T:Aspose.Words.FileCorruptedException">The document appears to be corrupted and cannot be loaded.</exception><exception cref="T:System.Exception">There is a problem with the document and it should be reported to Aspose.Words developers.</exception><exception cref="T:System.IO.IOException">There is an input/output exception.</exception><exception cref="T:Aspose.Words.IncorrectPasswordException">The document is encrypted and requires a password to open, but you supplied an incorrect password.</exception><exception cref="T:System.ArgumentNullException">The stream cannot be null.</exception><exception cref="T:System.NotSupportedException">The stream does not support reading or seeking.</exception><exception cref="T:System.ObjectDisposedException">The stream is a disposed object.</exception></member>
- <member name="M:Aspose.Words.Document.#ctor(System.IO.Stream,Aspose.Words.LoadOptions)">
- <summary>
- Opens an existing document from a stream. Allows to specify additional options such as an encryption password.
- </summary>
- <remarks>
- <p>
- The document must be stored at the beginning of the stream. The stream must support random positioning.</p>
- </remarks>
- <param name="stream">The stream where to load the document from.</param>
- <param name="loadOptions">Additional options to use when loading a document. Can be null.</param>
- <exception cref="T:Aspose.Words.UnsupportedFileFormatException">The document format is not recognized or not supported.</exception>
- <exception cref="T:Aspose.Words.FileCorruptedException">The document appears to be corrupted and cannot be loaded.</exception>
- <exception cref="T:System.Exception">There is a problem with the document and it should be reported to Aspose.Words developers.</exception>
- <exception cref="T:System.IO.IOException">There is an input/output exception.</exception>
- <exception cref="T:Aspose.Words.IncorrectPasswordException">The document is encrypted and requires a password to open, but you supplied an incorrect password.</exception>
- <exception cref="T:System.ArgumentNullException">The stream cannot be null.</exception>
- <exception cref="T:System.NotSupportedException">The stream does not support reading or seeking.</exception>
- <exception cref="T:System.ObjectDisposedException">The stream is a disposed object.</exception>
- </member>
- <member name="M:Aspose.Words.Document.Clone">
- <summary>
- Performs a deep copy of the <see cref="T:Aspose.Words.Document" />.
- </summary>
- <returns>The cloned document.</returns>
- <dev>Kept to remain compatible with the old API.</dev>
- </member>
- <member name="M:Aspose.Words.Document.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls DocumentVisitor.VisitDocumentStart, then calls Accept for all child nodes of the document
- and calls DocumentVisitor.VisitDocumentEnd at the end.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Document.AppendDocument(Aspose.Words.Document,Aspose.Words.ImportFormatMode)">
- <summary>
- Appends the specified document to the end of this document.
- </summary>
- <param name="srcDoc">The document to append.</param>
- <param name="importFormatMode">Specifies how to merge style formatting that clashes.</param>
- </member>
- <member name="M:Aspose.Words.Document.AppendDocument(Aspose.Words.Document,Aspose.Words.ImportFormatMode,Aspose.Words.ImportFormatOptions)">
- <summary>
- Appends the specified document to the end of this document.
- </summary>
- <param name="srcDoc">The document to append.</param>
- <param name="importFormatMode">Specifies how to merge style formatting that clashes.</param>
- <param name="importFormatOptions">Allows to specify options that affect formatting of a result document.</param>
- </member>
- <member name="M:Aspose.Words.Document.Save(System.String)">
- <overloads>Saves the document.</overloads>
- <summary>
- Saves the document to a file. Automatically determines the save format from the extension.
- </summary>
- <param name="fileName">The name for the document. If a document with the
- specified file name already exists, the existing document is overwritten.</param>
- <returns>Additional information that you can optionally use.</returns>
- </member>
- <member name="M:Aspose.Words.Document.Save(System.String,Aspose.Words.SaveFormat)">
- <summary>
- Saves the document to a file in the specified format.
- </summary>
- <param name="fileName">The name for the document. If a document with the
- specified file name already exists, the existing document is overwritten.</param>
- <param name="saveFormat">The format in which to save the document.</param>
- <returns>Additional information that you can optionally use.</returns>
- </member>
- <member name="M:Aspose.Words.Document.Save(System.String,Aspose.Words.Saving.SaveOptions)">
- <summary>
- Saves the document to a file using the specified save options.
- </summary>
- <param name="fileName">The name for the document. If a document with the
- specified file name already exists, the existing document is overwritten.</param>
- <param name="saveOptions">Specifies the options that control how the document is saved. Can be null.</param>
- <returns>Additional information that you can optionally use.</returns>
- </member>
- <member name="M:Aspose.Words.Document.Save(System.IO.Stream,System.String,Aspose.Words.Saving.SaveOptions)">
- <summary>
- Saves the document to a stream or file using the specified save options.
- </summary>
- <param name="stream">Stream where to save the document.
- Can be null.</param>
- <param name="fileName">The name for the document. If a document with the
- specified file name already exists, the existing document is overwritten.
- Can be null.</param>
- <param name="saveOptions">Specifies the options that control how the document is saved. Can be null.</param>
- <returns>Additional information that you can optionally use.</returns>
- </member>
- <member name="M:Aspose.Words.Document.Save(System.IO.Stream,Aspose.Words.SaveFormat)">
- <summary>
- Saves the document to a stream using the specified format.
- </summary>
- <param name="stream">Stream where to save the document.</param>
- <param name="saveFormat">The format in which to save the document.</param>
- <returns>Additional information that you can optionally use.</returns>
- </member>
- <member name="M:Aspose.Words.Document.Save(System.IO.Stream,Aspose.Words.Saving.SaveOptions)">
- <summary>
- Saves the document to a stream using the specified save options.
- </summary>
- <param name="stream">Stream where to save the document.</param>
- <param name="saveOptions">Specifies the options that control how the document is saved. Can be null.
- If this is null, the document will be saved in the binary DOC format.</param>
- <returns>Additional information that you can optionally use.</returns>
- </member>
- <member name="M:Aspose.Words.Document.EnsureMinimum">
- <summary>
- If the document contains no sections, creates one section with one paragraph.
- </summary>
- </member>
- <member name="M:Aspose.Words.Document.AcceptAllRevisions">
- <summary>
- Accepts all tracked changes in the document.
- </summary>
- <remarks>This method is a shortcut for <see cref="M:Aspose.Words.RevisionCollection.AcceptAll" />.</remarks>
- </member>
- <member name="M:Aspose.Words.Document.Protect(Aspose.Words.ProtectionType)">
- <overloads>Protects the document from changes.</overloads>
- <summary>
- Protects the document from changes without changing the existing password or assigns a random password.
- </summary>
- <remarks>
- <p>When a document is protected, the user can make only limited changes,
- such as adding annotations, making revisions, or completing a form.</p>
- <p>When you protect a document, and the document already has a protection password,
- the existing protection password is not changed.</p>
- <p>When you protect a document, and the document does not have a protection password,
- this method assigns a random password that makes it impossible to unprotect the document
- in Microsoft Word, but you still can unprotect the document in Aspose.Words as it does not
- require a password when unprotecting.</p>
- </remarks>
- <param name="type">Specifies the protection type for the document.</param>
- </member>
- <member name="M:Aspose.Words.Document.Protect(Aspose.Words.ProtectionType,System.String)">
- <summary>
- Protects the document from changes and optionally sets a protection password.
- </summary>
- <remarks>
- <p>When a document is protected, the user can make only limited changes,
- such as adding annotations, making revisions, or completing a form.</p>
- <para>Note that document protection is different from write protection.
- Write protection is specified using the <see cref="P:Aspose.Words.Document.WriteProtection" />.</para>
- </remarks>
- <param name="type">Specifies the protection type for the document.</param>
- <param name="password">The password to protect the document with.
- Specify null or empty string if you want to protect the document without a password.</param>
- </member>
- <member name="M:Aspose.Words.Document.Unprotect">
- <overloads>Removes protection from the document.</overloads>
- <summary>
- Removes protection from the document regardless of the password.
- </summary>
- <remarks>
- <para>This method unprotects the document even if it has a protection password.</para>
- <para>Note that document protection is different from write protection.
- Write protection is specified using the <see cref="P:Aspose.Words.Document.WriteProtection" />.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Document.Unprotect(System.String)">
- <summary>
- Removes protection from the document if a correct password is specified.
- </summary>
- <remarks>
- <para>This method unprotects the document only if a correct password is specified.</para>
- <para>Note that document protection is different from write protection.
- Write protection is specified using the <see cref="P:Aspose.Words.Document.WriteProtection" />.</para>
- </remarks>
- <param name="password">The password to unprotect the document with.</param>
- <returns>True if a correct password was specified and the document was unprotected.</returns>
- </member>
- <member name="M:Aspose.Words.Document.UpdateWordCount">
- <summary>
- Updates word count properties of the document.
- </summary>
- <remarks>
- <p>
- <b>UpdateWordCount</b> recalculates and updates Characters, Words and Paragraphs
- properties in the <see cref="P:Aspose.Words.Document.BuiltInDocumentProperties" /> collection of the <b>Document</b>.</p>
- <p>Note that <b>UpdateWordCount</b> does not update number of lines and pages properties.
- Use the <see cref="M:Aspose.Words.Document.UpdateWordCount" /> overload and pass True value as a parameter to do that.</p>
- <p>When you use an evaluation version, the evaluation watermark will also be included
- in the word count.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Document.UpdateWordCount(System.Boolean)">
- <summary>
- Updates word count properties of the document, optionally updates <see cref="P:Aspose.Words.Properties.BuiltInDocumentProperties.Lines" /> property.
- </summary>
- <remarks>
- This method will rebuild page layout of the document.
- </remarks>
- <param name="updateLinesCount">True if number of lines in the document shall be calculated.</param>
- </member>
- <member name="M:Aspose.Words.Document.UpdateTableLayout">
- <summary>
- Updates widths of cells and tables in the document according to their preferred widths and content.
- You do not need to call this method if the tables appear correct in the output document.
- </summary>
- <remarks>
- <p>You do not normally need to call this method as cell and table widths are maintained automatically.
- You can call this method before exporting to PDF (or any other fixed-page format), only in rare cases
- where you confirmed that tables appear incorrectly laid out in the output document. Calling this method
- might help to correct the output.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Document.UpdateListLabels">
- <summary>
- Updates list labels for all list items in the document.
- </summary>
- <remarks>
- <para>This method updates list label properties such as <see cref="P:Aspose.Words.Lists.ListLabel.LabelValue" /> and
- <see cref="P:Aspose.Words.Lists.ListLabel.LabelString" /> for each <see cref="P:Aspose.Words.Paragraph.ListLabel" /> object in the document.</para>
- <para>Also, this method is sometimes implicitly called when updating fields in the document. This is required
- because some fields that may reference list numbers (such as TOC or REF) need them be up-to-date.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Document.RemoveMacros">
- <summary>
- Removes all macros (the VBA project) as well as toolbars and command customizations from the document.
- </summary>
- <remarks>
- <p>By removing all macros from a document you can ensure the document contains no macro viruses.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Document.UpdateFields">
- <summary>
- Updates the values of fields in the whole document.
- </summary>
- <remarks>
- <para>When you open, modify and then save a document, Aspose.Words does not update fields automatically, it keeps them intact.
- Therefore, you would usually want to call this method before saving if you have modified the document
- programmatically and want to make sure the proper (calculated) field values appear in the saved document.</para>
- <para>There is no need to update fields after executing a mail merge because mail merge is a kind of field update
- and automatically updates all fields in the document.</para>
- <p>This method does not update all field types. For the detailed list of supported field types, see the Programmers Guide.</p>
- <para>This method does not update fields that are related to the page layout algorithms (e.g. PAGE, PAGES, PAGEREF).
- The page layout-related fields are updated when you render a document or call <see cref="M:Aspose.Words.Document.UpdatePageLayout" />.</para>
- <para>Use the <see cref="M:Aspose.Words.Document.NormalizeFieldTypes" /> method before fields updating if there were document changes that affected field types.</para>
- <para>To update fields in a specific part of the document use <see cref="M:Aspose.Words.Range.UpdateFields" />.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Document.UnlinkFields">
- <summary>
- Unlinks fields in the whole document.
- </summary>
- <remarks>
- <para>Replaces all the fields in the whole document with their most recent results.</para>
- <para>To unlink fields in a specific part of the document use <see cref="M:Aspose.Words.Range.UnlinkFields" />.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Document.NormalizeFieldTypes">
- <summary>
- Changes field type values <see cref="P:Aspose.Words.Fields.FieldChar.FieldType" /> of <see cref="T:Aspose.Words.Fields.FieldStart" />, <see cref="T:Aspose.Words.Fields.FieldSeparator" />, <see cref="T:Aspose.Words.Fields.FieldEnd" />
- in the whole document so that they correspond to the field types contained in the field codes.
- </summary>
- <remarks>
- <para>Use this method after document changes that affect field types.</para>
- <para>To change field type values in a specific part of the document use <see cref="M:Aspose.Words.Range.NormalizeFieldTypes" />.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Document.JoinRunsWithSameFormatting">
- <summary>
- Joins runs with same formatting in all paragraphs of the document.
- </summary>
- <remarks>
- <p>This is an optimization method. Some documents contain adjacent runs with same formatting.
- Usually this occurs if a document was intensively edited manually.
- You can reduce the document size and speed up further processing by joining these runs.</p>
- <p>The operation checks every <see cref="T:Aspose.Words.Paragraph" /> node in the document for adjacent <see cref="T:Aspose.Words.Run" />
- nodes having identical properties. It ignores unique identifiers used to track editing sessions of run
- creation and modification. First run in every joining sequence accumulates all text. Remaining
- runs are deleted from the document.</p>
- </remarks>
- <returns>Number of joins performed. When <b>N</b> adjacent runs are being joined they count as <b>N - 1</b> joins.</returns>
- </member>
- <member name="M:Aspose.Words.Document.ExpandTableStylesToDirectFormatting">
- <summary>
- Converts formatting specified in table styles into direct formatting on tables in the document.
- </summary>
- <remarks>
- <para>This method exists because this version of Aspose.Words provides only limited support for
- table styles (see below). This method might be useful when you load a DOCX or WordprocessingML
- document that contains tables formatted with table styles and you need to query formatting of
- tables, cells, paragraphs or text.</para>
- <para>This version of Aspose.Words provides limited support for table styles as follows:</para>
- <list type="bullet">
- <item>Table styles defined in DOCX or WordprocessingML documents are preserved as table styles
- when saving the document as DOCX or WordprocessingML.</item>
- <item>Table styles defined in DOCX or WordprocessingML documents are automatically converted
- to direct formatting on tables when saving the document into any other format,
- rendering or printing.</item>
- <item>Table styles defined in DOC documents are preserved as table styles when
- saving the document as DOC only.</item>
- </list>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Document.Cleanup">
- <summary>
- Cleans unused styles and lists from the document.
- </summary>
- </member>
- <member name="M:Aspose.Words.Document.Cleanup(Aspose.Words.CleanupOptions)">
- <summary>
- Cleans unused styles and lists from the document depending on given <see cref="T:Aspose.Words.CleanupOptions" />.
- </summary>
- </member>
- <member name="M:Aspose.Words.Document.RemoveExternalSchemaReferences">
- <summary>
- Removes external XML schema references from this document.
- </summary>
- </member>
- <member name="M:Aspose.Words.Document.StartTrackRevisions(System.String,System.DateTime)">
- <summary>
- Starts automatically marking all further changes you make to the document programmatically as revision changes.
- </summary>
- <remarks>
- <p>If you call this method 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.</p>
- <p>Currently Aspose.Words supports tracking of node insertions and deletions only. Formatting changes are not
- recorded as revisions.</p>
- <p>Automatic tracking of changes is supported both when modifying this document through node manipulations
- as well as when using <see cref="T:Aspose.Words.DocumentBuilder" /></p>
- <p>This method does not change the <see cref="P:Aspose.Words.Document.TrackRevisions" /> option and does not use its value
- for the purposes of revision tracking.</p>
- </remarks>
- <param name="author">Initials of the author to use for revisions.</param>
- <param name="dateTime">The date and time to use for revisions.</param>
- <seealso cref="M:Aspose.Words.Document.StopTrackRevisions" />
- </member>
- <member name="M:Aspose.Words.Document.StartTrackRevisions(System.String)">
- <summary>
- Starts automatically marking all further changes you make to the document programmatically as revision changes.
- </summary>
- <remarks>
- <p>If you call this method 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.</p>
- <p>Currently Aspose.Words supports tracking of node insertions and deletions only. Formatting changes are not
- recorded as revisions.</p>
- <p>Automatic tracking of changes is supported both when modifying this document through node manipulations
- as well as when using <see cref="T:Aspose.Words.DocumentBuilder" /></p>
- <p>This method does not change the <see cref="P:Aspose.Words.Document.TrackRevisions" /> option and does not use its value
- for the purposes of revision tracking.</p>
- </remarks>
- <param name="author">Initials of the author to use for revisions.</param>
- <seealso cref="M:Aspose.Words.Document.StopTrackRevisions" />
- </member>
- <member name="M:Aspose.Words.Document.StopTrackRevisions">
- <summary>
- Stops automatic marking of document changes as revisions.
- </summary>
- <seealso cref="M:Aspose.Words.Document.StartTrackRevisions(System.String,System.DateTime)" />
- </member>
- <member name="M:Aspose.Words.Document.Compare(Aspose.Words.Document,System.String,System.DateTime)">
- <summary>
- Compares this document with another document producing changes as number of edit and format revisions <see cref="T:Aspose.Words.Revision" />.
- </summary>
- <param name="document">Document to compare.</param>
- <param name="author">Initials of the author to use for revisions.</param>
- <param name="dateTime">The date and time to use for revisions.</param>
- <remarks>The following document nodes are not compared at the moment:
- <list type="bullet"><item><see cref="T:Aspose.Words.Markup.StructuredDocumentTag" /></item><item>Item3</item></list><note>Documents must not have revisions before comparison.</note></remarks>
- </member>
- <member name="M:Aspose.Words.Document.Compare(Aspose.Words.Document,System.String,System.DateTime,Aspose.Words.CompareOptions)">
- <summary>
- Compares this document with another document producing changes as a number of edit and format revisions <see cref="T:Aspose.Words.Revision" />.
- Allows to specify comparison options using <see cref="T:Aspose.Words.CompareOptions" />.
- </summary>
- </member>
- <member name="M:Aspose.Words.Document.CopyStylesFromTemplate(System.String)">
- <summary>
- Copies styles from the specified template to a document.
- </summary>
- <remarks>
- When styles are copied from a template to a document,
- like-named styles in the document are redefined to match the style descriptions in the template.
- Unique styles from the template are copied to the document. Unique styles in the document remain intact.
- </remarks>
- <dev>
- AM. This is experimental method for WORDSNET-16783.
- Customer trying to copy all styles but we don't fully understand his requirements.
- He wants preserve style hierarchy and this is not possible if copy styles one by one as
- we resolve style in destination collection and update links to based and linked styles
- accordingly.
- </dev>
- </member>
- <member name="M:Aspose.Words.Document.CopyStylesFromTemplate(Aspose.Words.Document)">
- <summary>
- Copies styles from the specified template to a document.
- </summary>
- <remarks>
- When styles are copied from a template to a document,
- like-named styles in the document are redefined to match the style descriptions in the template.
- Unique styles from the template are copied to the document. Unique styles in the document remain intact.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Document.UpdatePageLayout">
- <summary>
- Rebuilds the page layout of the document.
- </summary>
- <remarks>
- <para>This method formats a document into pages and updates the page number related fields in the document such
- as PAGE, PAGES, PAGEREF and REF. The up-to-date page layout information is required for a correct rendering of the document
- to fixed-page formats.</para>
- <para>This method is automatically invoked when you first convert a document to PDF, XPS, image or print it.
- However, if you modify the document after rendering and then attempt to render it again - Aspose.Words will not
- update the page layout automatically. In this case you should call <see cref="M:Aspose.Words.Document.UpdatePageLayout" /> before
- rendering again.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Document.RenderToScale(System.Int32,System.Drawing.Graphics,System.Single,System.Single,System.Single)">
- <summary>
- Renders a document page into a <see cref="T:System.Drawing.Graphics" /> object to a specified scale.
- </summary>
- <param name="pageIndex">The 0-based page index.</param>
- <param name="graphics">The object where to render to.</param>
- <param name="x">The X coordinate (in world units) of the top left corner of the rendered page.</param>
- <param name="y">The Y coordinate (in world units) of the top left corner of the rendered page.</param>
- <param name="scale">The scale for rendering the page (1.0 is 100%).</param>
- <returns>The width and height (in world units) of the rendered page.</returns>
- </member>
- <member name="M:Aspose.Words.Document.RenderToSize(System.Int32,System.Drawing.Graphics,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Renders a document page into a <see cref="T:System.Drawing.Graphics" /> object to a specified size.
- </summary>
- <param name="pageIndex">The 0-based page index.</param>
- <param name="graphics">The object where to render to.</param>
- <param name="x">The X coordinate (in world units) of the top left corner of the rendered page.</param>
- <param name="y">The Y coordinate (in world units) of the top left corner of the rendered page.</param>
- <param name="width">The maximum width (in world units) that can be occupied by the rendered page.</param>
- <param name="height">The maximum height (in world units) that can be occupied by the rendered page.</param>
- <returns>The scale that was automatically calculated for the rendered page to fit the specified size.</returns>
- </member>
- <member name="M:Aspose.Words.Document.GetPageInfo(System.Int32)">
- <summary>
- Gets the page size, orientation and other information about a page that might be useful for printing or rendering.
- </summary>
- <param name="pageIndex">The 0-based page index.</param>
- </member>
- <member name="M:Aspose.Words.Document.Print">
- <overloads>Prints the document without bringing up any user interface forms.</overloads>
- <summary>
- Prints the whole document to the default printer.
- </summary>
- </member>
- <member name="M:Aspose.Words.Document.Print(System.String)">
- <summary>
- Print the whole document to the specified printer,
- using the standard (no User Interface) print controller.
- </summary>
- <param name="printerName">The name of the printer.</param>
- </member>
- <member name="M:Aspose.Words.Document.Print(System.Drawing.Printing.PrinterSettings)">
- <summary>
- Prints the document according to the specified printer settings,
- using the standard (no User Interface) print controller.
- </summary>
- <remarks>
- <para>The <see cref="T:System.Drawing.Printing.PrinterSettings" />
- object allows you to specify the printer to print on, the range of pages of to print and other options.</para>
- </remarks>
- <param name="printerSettings">The printer settings to use.</param>
- </member>
- <member name="M:Aspose.Words.Document.Print(System.Drawing.Printing.PrinterSettings,System.String)">
- <summary>
- Prints the document according to the specified printer settings,
- using the standard (no User Interface) print controller and a document name.
- </summary>
- <remarks>
- <para>The <see cref="T:System.Drawing.Printing.PrinterSettings" />
- object allows you to specify the printer to print on, the range of pages of to print and other options.</para>
- </remarks>
- <param name="printerSettings">The printer settings to use.</param>
- <param name="documentName">The document name to display (for example, in a print status dialog
- box or printer queue) while printing the document.</param>
- </member>
- <member name="M:Aspose.Words.Document.UpdateThumbnail(Aspose.Words.Rendering.ThumbnailGeneratingOptions)">
- <summary>
- Updates <see cref="P:Aspose.Words.Properties.BuiltInDocumentProperties.Thumbnail" /> of the document according to the specified options.
- </summary>
- <remarks>
- The <see cref="T:Aspose.Words.Rendering.ThumbnailGeneratingOptions" /> allows you to specify the source of thumbnail, size and other options.
- If attempt to generate thumbnail fails, doesn't change one.
- </remarks>
- <param name="options">The generating options to use.</param>
- </member>
- <member name="M:Aspose.Words.Document.UpdateThumbnail">
- <summary>
- Updates <see cref="P:Aspose.Words.Properties.BuiltInDocumentProperties.Thumbnail" /> of the document using default options.
- </summary>
- </member>
- <member name="M:Aspose.Words.Document.ExtractPages(System.Int32,System.Int32)">
- <summary>
- Returns the <see cref="T:Aspose.Words.Document" /> object representing specified range of pages.
- </summary>
- <remarks>
- The resulting document should look like the one in MS Word, as if we had performed 'Print specific pages' – the numbering,
- headers/footers and cross tables layout will be preserved.
- But due to a large number of nuances, appearing while reducing the number of pages, full match of the layout is a quiet complicated task requiring a lot of effort.
- Depending on the document complexity there might be slight differences in the resulting document contents layout comparing to the source document.
- Any feedback would be greatly appreciated.
- </remarks>
- <param name="index">The zero-based index of the first page to extract.</param>
- <param name="count">Number of pages to be extracted.</param>
- </member>
- <member name="P:Aspose.Words.Document.AttachedTemplate">
- <summary>
- Gets or sets the full path of the template attached to the document.
- </summary>
- <remarks>
- <p>Empty string means the document is attached to the Normal template.</p>
- <seealso cref="P:Aspose.Words.Properties.BuiltInDocumentProperties.Template" />
- </remarks>
- <exception cref="T:System.ArgumentNullException">Throws if you attempt to set to a null value.</exception>
- </member>
- <member name="P:Aspose.Words.Document.AutomaticallyUpdateStyles">
- <summary>
- Gets or sets a flag indicating whether the styles in the document are updated to match the styles in the
- attached template each time the document is opened in MS Word.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.ShadeFormData">
- <summary>
- Specifies whether to turn on the gray shading on form fields.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.TrackRevisions">
- <summary>
- <b>True</b> if changes are tracked when this document is edited in Microsoft Word.
- </summary>
- <remarks>
- <p>Setting this option only instructs Microsoft Word whether the track changes
- is turned on or off. This property has no effect on changes to the document that you make
- programmatically via Aspose.Words.</p>
- <p>If you want to automatically track changes as they are made programmatically by Aspose.Words
- to this document use the <see cref="M:Aspose.Words.Document.StartTrackRevisions(System.String,System.DateTime)" /> method.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.ShowGrammaticalErrors">
- <summary>
- Specifies whether to display grammar errors in this document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.ShowSpellingErrors">
- <summary>
- Specifies whether to display spelling errors in this document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.NodeType">
- <summary>
- Returns <b>NodeType.Document</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.BuiltInDocumentProperties">
- <summary>
- Returns a collection that represents all the built-in document properties of the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.WebExtensionTaskPanes">
- <summary>
- Returns a collection that represents a list of task pane add-ins.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.CustomDocumentProperties">
- <summary>
- Returns a collection that represents all the custom document properties of the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.MailMerge">
- <summary>
- Returns a <b>MailMerge</b> object that represents the mail merge functionality for the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.ProtectionType">
- <summary>
- Gets the currently active document protection type.
- </summary>
- <remarks>
- <p>This property allows to retrieve the currently set document protection type.
- To change the document protection type use the <see cref="M:Aspose.Words.Document.Protect(Aspose.Words.ProtectionType,System.String)" />
- and <see cref="M:Aspose.Words.Document.Unprotect" /> methods.</p>
- <p>When a document is protected, the user can make only limited changes,
- such as adding annotations, making revisions, or completing a form.</p>
- <para>Note that document protection is different from write protection.
- Write protection is specified using the <see cref="P:Aspose.Words.Document.WriteProtection" /></para>
- <seealso cref="M:Aspose.Words.Document.Protect(Aspose.Words.ProtectionType,System.String)" />
- <seealso cref="M:Aspose.Words.Document.Unprotect" />
- <seealso cref="P:Aspose.Words.Document.WriteProtection" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.Sections">
- <summary>
- Returns a collection that represents all sections in the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.FirstSection">
- <summary>
- Gets the first section in the document.
- </summary>
- <remarks>
- Returns <c>null</c> if there are no sections.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.LastSection">
- <summary>
- Gets the last section in the document.
- </summary>
- <remarks>
- Returns <c>null</c> if there are no sections.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.ViewOptions">
- <summary>
- Provides options to control how the document is displayed in Microsoft Word.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.WriteProtection">
- <summary>
- Provides access to the document write protection options.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.CompatibilityOptions">
- <summary>
- Provides access to document compatibility options (that is, the user preferences entered on the <b>Compatibility</b>
- tab of the <b>Options</b> dialog in Word).
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.MailMergeSettings">
- <summary>
- Gets or sets the object that contains all of the mail merge information for a document.
- </summary>
- <remarks>
- <para>You can use this object to specify a mail merge data source for a document and this information
- (along with the available data fields) will appear in Microsoft Word when the user opens this document.
- Or you can use this object to query mail merge settings that the user has specified in Microsoft Word
- for this document.</para>
- <para>This object is never null.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.HyphenationOptions">
- <summary>
- Provides access to document hyphenation options.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.HasRevisions">
- <summary>
- Returns <b>true</b> if the document has any tracked changes.
- </summary>
- <remarks>
- This property is a shortcut for comparing <see cref="P:Aspose.Words.RevisionCollection.Count" /> to zero.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.HasMacros">
- <summary>
- Returns <b>true</b> if the document has a VBA project (macros).
- </summary>
- <seealso cref="M:Aspose.Words.Document.RemoveMacros" />
- </member>
- <member name="P:Aspose.Words.Document.Watermark">
- <summary>
- Provides access to the document watermark.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.VersionsCount">
- <summary>
- Gets the number of document versions that was stored in the DOC document.
- </summary>
- <remarks>
- <p>Versions in Microsoft Word are accessed via the File/Versions menu. Microsoft Word supports
- versions only for DOC files.</p>
- <p>This property allows to detect if there were document versions stored in this document
- before it was opened in Aspose.Words. Aspose.Words provides no other support for document versions.
- If you save this document using Aspose.Words, the document will be saved without versions.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.DefaultTabStop">
- <summary>
- Gets or sets the interval (in points) between the default tab stops.
- </summary>
- <seealso cref="T:Aspose.Words.TabStopCollection" />
- <seealso cref="T:Aspose.Words.TabStop" />
- </member>
- <member name="P:Aspose.Words.Document.Theme">
- <summary>
- Gets the <see cref="P:Aspose.Words.Document.Theme" /> object for this document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.CustomXmlParts">
- <summary>
- Gets or sets the collection of Custom XML Data Storage Parts.
- </summary>
- <remarks>
- <para>Aspose.Words loads and saves Custom XML Parts into OOXML and DOC documents only.</para>
- <para>This property cannot be <c>null</c>.</para>
- <seealso cref="T:Aspose.Words.Markup.CustomXmlPart" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.PackageCustomParts">
- <summary>
- Gets or sets the collection of custom parts (arbitrary content) that are linked to the OOXML package using "unknown relationships".
- </summary>
- <remarks>
- <para>Do not confuse these custom parts with Custom XML Data. If you need to access Custom XML parts,
- use the <see cref="P:Aspose.Words.Document.CustomXmlParts" /> property.</para>
- <para>This collection contains OOXML parts whose parent is the OOXML package and they targets are of an "unknown relationship".
- For more information see <see cref="T:Aspose.Words.Markup.CustomPart" />.</para>
- <para>Aspose.Words loads and saves custom parts into OOXML documents only.</para>
- <para>This property cannot be <c>null</c>.</para>
- <seealso cref="T:Aspose.Words.Markup.CustomPart" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.Variables">
- <summary>
- Returns the collection of variables added to a document or template.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.GlossaryDocument">
- <summary>
- Gets or sets the glossary document within this document or template. A glossary document is a storage
- for AutoText, AutoCorrect and Building Block entries defined in a document.
- </summary>
- <remarks>
- <para>This property returns <c>null</c> if the document does not have a glossary document.</para>
- <para>You can add a glossary document to a document by creating a
- <see cref="T:Aspose.Words.BuildingBlocks.GlossaryDocument" /> object and assigning to this property.</para>
- <seealso cref="T:Aspose.Words.BuildingBlocks.GlossaryDocument" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.OriginalFileName">
- <summary>
- Gets the original file name of the document.
- </summary>
- <remarks>
- <p>Returns null if the document was loaded from a stream or created blank.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.OriginalLoadFormat">
- <summary>
- Gets the format of the original document that was loaded into this object.
- </summary>
- <remarks>
- <para>If you created a new blank document, returns the <see cref="F:Aspose.Words.LoadFormat.Doc" /> value.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.Compliance">
- <summary>
- Gets the OOXML compliance version determined from the loaded document content.
- Makes sense only for OOXML documents.
- </summary>
- <remarks>
- <para>If you created a new blank document or load non OOXML document
- returns the <see cref="F:Aspose.Words.Saving.OoxmlCompliance.Ecma376_2006" /> value.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.DigitalSignatures">
- <summary>
- Gets the collection of digital signatures for this document and their validation results.
- </summary>
- <remarks>
- <para>This collection contains digital signatures that were loaded from the original document.
- These digital signatures will not be saved when you save this <see cref="T:Aspose.Words.Document" /> object
- into a file or stream because saving or converting will produce a document that is different from the
- original and the original digital signatures will no longer be valid.</para>
- <para>This collection is never null. If the document is not signed, it will contain zero elements.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.FontSettings">
- <summary>
- Gets or sets document font settings.
- </summary>
- <remarks>
- <para>This property allows to specify font settings per document. If set to null, default static font settings
- <see cref="P:Aspose.Words.Fonts.FontSettings.DefaultInstance" /> will be used.</para>
- <para>The default value is null.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.PageCount">
- <summary>
- Gets the number of pages in the document as calculated by the most recent page layout operation.
- </summary>
- <seealso cref="M:Aspose.Words.Document.UpdatePageLayout" />
- </member>
- <member name="P:Aspose.Words.Document.Revisions">
- <summary>
- Gets a collection of revisions (tracked changes) that exist in this document.
- </summary>
- <remarks>
- <para>The returned collection is a "live" collection, which means if you remove parts of a document that contain
- revisions, the deleted revisions will automatically disappear from this collection.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Document.LayoutOptions">
- <summary>
- Gets a <b>LayoutOptions</b> object that represents options to control the layout process of this document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.RevisionsView">
- <summary>
- Gets or sets a value indicating whether to work with the original or revised version of a document.
- </summary>
- <remarks>
- The default value is <b><see cref="F:Aspose.Words.RevisionsView.Original" /></b>.
- </remarks>
- <dev>
- Currently this option is supported for <see cref="P:Aspose.Words.Lists.ListLabel.LabelString" />
- and <see cref="P:Aspose.Words.ListFormat.ListLevel" /> only.
- </dev>
- </member>
- <member name="P:Aspose.Words.Document.FootnoteOptions">
- <summary>
- Provides options that control numbering and positioning of footnotes in this document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.EndnoteOptions">
- <summary>
- Provides options that control numbering and positioning of endnotes in this document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.FieldOptions">
- <summary>
- Gets a <b>FieldOptions</b> object that represents options to control field handling in the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.RemovePersonalInformation">
- <summary>
- Gets or sets a flag indicating that Microsoft Word will remove all user information from comments, revisions and
- document properties upon saving the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Document.VbaProject">
- <summary>
- Gets or sets a <see cref="P:Aspose.Words.Document.VbaProject" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.DocumentBuilder">
- <summary>
- Provides methods to insert text, images and other content, specify font, paragraph and section formatting.
- </summary>
- <remarks>
- <p>
- <b>DocumentBuilder</b> makes the process of building a <b>Document</b> easier.
- <b>Document</b> is a composite object consisting of a tree of nodes and while inserting content
- nodes directly into the tree is possible, it requires good understanding of the tree structure.
- <b>DocumentBuilder</b> is a "facade" for the complex structure of <b>Document</b> and allows
- to insert content and formatting quickly and easily.</p>
- <p>Create a <b>DocumentBuilder</b> and associate it with a <see cref="P:Aspose.Words.DocumentBuilder.Document" />.</p>
- <p>The <b>DocumentBuilder</b> has an internal cursor where the text will be inserted
- when you call <see cref="M:Aspose.Words.DocumentBuilder.Write(System.String)" />, <see cref="M:Aspose.Words.DocumentBuilder.Writeln(System.String)" />, <see cref="M:Aspose.Words.DocumentBuilder.InsertBreak(Aspose.Words.BreakType)" />
- and other methods. You can navigate the <b>DocumentBuilder</b> cursor to a different location
- in a document using various MoveToXXX methods.</p>
- <p>Use the <see cref="P:Aspose.Words.DocumentBuilder.Font" /> property to specify character formatting that will apply to
- all text inserted from the current position in the document onwards.</p>
- <p>Use the <see cref="P:Aspose.Words.DocumentBuilder.ParagraphFormat" /> property to specify paragraph formatting for the current
- and all paragraphs that will be inserted.</p>
- <p>Use the <see cref="P:Aspose.Words.DocumentBuilder.PageSetup" /> property to specify page and section properties for the current
- section and all section that will be inserted.</p>
- <p>Use the <see cref="P:Aspose.Words.DocumentBuilder.CellFormat" /> and <see cref="P:Aspose.Words.DocumentBuilder.RowFormat" /> properties to specify
- formatting properties for table cells and rows. User the <see cref="M:Aspose.Words.DocumentBuilder.InsertCell" /> and
- <see cref="M:Aspose.Words.DocumentBuilder.EndRow" /> methods to build a table.</p>
- <p>Note that <b>Font</b>, <b>ParagraphFormat</b> and <b>PageSetup</b> properties are updated whenever
- you navigate to a different place in the document to reflect formatting properties available at the new location.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.#ctor">
- <summary>
- Initializes a new instance of this class.
- </summary>
- <remarks>
- Creates a new <b>DocumentBuilder</b> object and attaches it to a new <see cref="P:Aspose.Words.DocumentBuilder.Document" /> object.
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.#ctor(Aspose.Words.Document)">
- <summary>
- Initializes a new instance of this class.
- </summary>
- <remarks>
- Creates a new <b>DocumentBuilder</b> object, attaches to the specified <see cref="P:Aspose.Words.DocumentBuilder.Document" /> object.
- The cursor is positioned at the beginning of the document.
- </remarks>
- <param name="doc">The Document object to attach to.</param>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.MoveToDocumentStart">
- <summary>
- Moves the cursor to the beginning of the document.
- </summary>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.MoveToDocumentEnd">
- <summary>
- Moves the cursor to the end of the document.
- </summary>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.MoveToSection(System.Int32)">
- <summary>
- Moves the cursor to the beginning of the body in a specified section.
- </summary>
- <remarks>
- <p>When sectionIndex is greater than or equal to 0, it specifies an index from
- the beginning of the document with 0 being the first section. When sectionIndex is less than 0,
- it specified an index from the end of the document with -1 being the last section.</p>
- <p>The cursor is moved to the first paragraph in the <b>Body</b> of the specified section.</p>
- </remarks>
- <param name="sectionIndex">The index of the section to move to.</param>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.MoveToHeaderFooter(Aspose.Words.HeaderFooterType)">
- <summary>
- Moves the cursor to the beginning of a header or footer in the current section.
- </summary>
- <remarks>
- <p>After you moved the cursor into a header or footer, you can use the rest of DocumentBuilder
- methods to modify the contents of the header or footer.</p>
- <p>If you want to create headers and footers different for the first page, you need
- to set <see cref="P:Aspose.Words.PageSetup.DifferentFirstPageHeaderFooter" />.</p>
- <p>If you want to create headers and footers different for even and odd pages, you need
- to set <see cref="P:Aspose.Words.PageSetup.OddAndEvenPagesHeaderFooter" />.</p>
- <p>Use <see cref="M:Aspose.Words.DocumentBuilder.MoveToSection(System.Int32)" /> to move out of the header into the main text.</p>
- </remarks>
- <param name="headerFooterType">Specifies the header or footer to move to.</param>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.MoveToMergeField(System.String)">
- <overloads>Moves the cursor to the specified merge field.</overloads>
- <summary>
- Moves the cursor to a position just beyond the specified merge field and removes the merge field.
- </summary>
- <remarks>
- <p>Note that this method deletes the merge field from the document after moving the cursor.</p>
- </remarks>
- <param name="fieldName">The case-insensitive name of the mail merge field.</param>
- <returns>True if the merge field was found and the cursor was moved; false otherwise.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.MoveToMergeField(System.String,System.Boolean,System.Boolean)">
- <summary>
- Moves the merge field to the specified merge field.
- </summary>
- <param name="fieldName">The case-insensitive name of the mail merge field.</param>
- <param name="isAfter">When true, moves the cursor to be after the field end.
- When false, moves the cursor to be before the field start. </param>
- <param name="isDeleteField">When true, deletes the merge field.</param>
- <returns>True if the merge field was found and the cursor was moved; false otherwise.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.MoveToField(Aspose.Words.Fields.Field,System.Boolean)">
- <summary>
- Moves the cursor to a field in the document.
- </summary>
- <param name="field">The field to move the cursor to.</param>
- <param name="isAfter">When true, moves the cursor to be after the field end.
- When false, moves the cursor to be before the field start. </param>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.MoveToBookmark(System.String)">
- <summary>
- Moves the cursor to a bookmark.
- </summary>
- <remarks>
- <p>Moves the cursor to a position just after the start of the bookmark with the
- specified name.</p>
- <p>The comparison is not case-sensitive. If the bookmark was not found, false is
- returned and the cursor is not moved.</p>
- <p>Inserting new text does not replace existing text of the bookmark.</p>
- <p>Note that some bookmarks in the document are assigned to form fields.
- Moving to such a bookmark and inserting text there inserts the text into the
- form field code. Although this will not invalidate the form field, the inserted
- text will not be visible because it becomes part of the field code.</p>
- </remarks>
- <param name="bookmarkName">The name of the bookmark to move the cursor to.</param>
- <returns>True if the bookmark was found; false otherwise.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.MoveToBookmark(System.String,System.Boolean,System.Boolean)">
- <summary>
- Moves the cursor to a bookmark with greater precision.
- </summary>
- <remarks>
- <p>Moves the cursor to a position before or after the bookmark start or end.</p>
- <p>If desired position is not at inline level, moves to the next paragraph.</p>
- <p>The comparison is not case-sensitive. If the bookmark was not found, false is
- returned and the cursor is not moved.</p>
- </remarks>
- <param name="bookmarkName">The name of the bookmark to move the cursor to.</param>
- <param name="isStart">When true, moves the cursor to the beginning of the bookmark.
- When false, moves the cursor to the end of the bookmark.</param>
- <param name="isAfter">When true, moves the cursor to be after the bookmark
- start or end position. When false, moves the cursor to be before the bookmark
- start or end position.</param>
- <returns>True if the bookmark was found; false otherwise.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.MoveToParagraph(System.Int32,System.Int32)">
- <summary>
- Moves the cursor to a paragraph in the current section.
- </summary>
- <remarks>
- <p>The navigation is performed inside the current story of the current section.
- That is, if you moved the cursor to the primary header of the first section,
- then paragraphIndex specified the index of the paragraph inside that header
- of that section.</p>
- <p>When paragraphIndex is greater than or equal to 0, it specifies an index from
- the beginning of the section with 0 being the first paragraph. When paragraphIndex is less than 0,
- it specified an index from the end of the section with -1 being the last paragraph.</p>
- </remarks>
- <param name="paragraphIndex">The index of the paragraph to move to.</param>
- <param name="characterIndex">The index of the character inside the paragraph.
- Currently can only specify 0 to move to the beginning of the paragraph or -1 to
- move to the end of the paragraph.
- </param>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.MoveToCell(System.Int32,System.Int32,System.Int32,System.Int32)">
- <summary>
- Moves the cursor to a table cell in the current section.
- </summary>
- <remarks>
- <p>The navigation is performed inside the current story of the current section.</p>
- <p>For the index parameters, when index is greater than or equal to 0, it specifies an index from
- the beginning with 0 being the first element. When index is less than 0, it specified an index from
- the end with -1 being the last element.</p>
- </remarks>
- <param name="tableIndex">The index of the table to move to.</param>
- <param name="rowIndex">The index of the row in the table.</param>
- <param name="columnIndex">The index of the column in the table.</param>
- <param name="characterIndex">The index of the character inside the cell.
- Currently can only specify 0 to move to the beginning of the cell or -1 to
- move to the end of the cell.</param>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.MoveTo(Aspose.Words.Paragraph,Aspose.Words.Node)">
- <summary>
- If inline node is not null, moves to it, otherwise moves to the paragraph node.
- </summary>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.MoveTo(Aspose.Words.Node)">
- <summary>
- Moves the cursor to an inline node or to the end of a paragraph.
- </summary>
- <remarks>
- <p>When <i>node</i> is an inline-level node, the cursor is moved to this node
- and further content will be inserted before that node.</p>
- <p>When <i>node</i> is a <b>Paragraph</b>, the cursor is moved to the end of the paragraph
- and further content will be inserted just before the paragraph break.</p>
- <p>When <i>node</i> is a block-level node but not a Paragraph, the cursor is moved to the end of the first paragraph into block-level node
- and further content will be inserted just before the paragraph break.</p>
- </remarks>
- <param name="node">The node must be a paragraph or a direct child of a paragraph.</param>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.DeleteRow(System.Int32,System.Int32)">
- <summary>
- Deletes a row from a table.
- </summary>
- <remarks>
- <p>If the cursor is inside the row that is being deleted, the cursor is moved
- out to the next row or to the next paragraph after the table.</p>
- <p>If you delete a row from a table that contains only one row, the whole
- table is deleted.</p>
- <p>For the index parameters, when index is greater than or equal to 0, it specifies an index from
- the beginning with 0 being the first element. When index is less than 0, it specified an index from
- the end with -1 being the last element.</p>
- </remarks>
- <param name="tableIndex">The index of the table.</param>
- <param name="rowIndex">The index of the row in the table.</param>
- <returns>The row node that was just removed.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.Write(System.String)">
- <summary>
- Inserts a string into the document at the current insert position.
- </summary>
- <remarks>
- Current font formatting specified by the <see cref="P:Aspose.Words.DocumentBuilder.Font" /> property is used.
- </remarks>
- <param name="text">The string to insert into the document.</param>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.Writeln(System.String)">
- <summary>
- Inserts a string and a paragraph break into the document.
- </summary>
- <remarks>
- Current font and paragraph formatting specified by the <see cref="P:Aspose.Words.DocumentBuilder.Font" /> and <see cref="P:Aspose.Words.DocumentBuilder.ParagraphFormat" /> properties are used.
- </remarks>
- <param name="text">The string to insert into the document.</param>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.Writeln">
- <summary>
- Inserts a paragraph break into the document.
- </summary>
- <remarks>
- <p>Calls <see cref="M:Aspose.Words.DocumentBuilder.InsertParagraph" />.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertParagraph">
- <summary>
- Inserts a paragraph break into the document.
- </summary>
- <remarks>
- <p>Current paragraph formatting specified by the <see cref="P:Aspose.Words.DocumentBuilder.ParagraphFormat" /> property is used.</p>
- <p>Breaks the current paragraph in two. After inserting the paragraph, the cursor is placed at the beginning of the new paragraph.</p>
- </remarks>
- <returns>The paragraph node that was just inserted. It is the same node as <see cref="P:Aspose.Words.DocumentBuilder.CurrentParagraph" />.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertStyleSeparator">
- <summary>
- Inserts style separator into the document.
- </summary>
- <remarks>
- This method allows to apply different paragraph styles to two different parts of a text line.
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertBreak(Aspose.Words.BreakType)">
- <summary>
- Inserts a break of the specified type into the document.
- </summary>
- <remarks>
- Use this method to insert paragraph, page, column, section or line break into the document.
- </remarks>
- <param name="breakType">Specifies the type of the break to insert.</param>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertTableOfContents(System.String)">
- <summary>
- Inserts a TOC (table of contents) field into the document.
- </summary>
- <remarks>
- <p>This method inserts a TOC (table of contents) field into the document at
- the current position.</p>
- <p>A table of contents in a Word document can be built in a number of ways
- and formatted using a variety of options. The way the table is built and
- displayed by Microsoft Word is controlled by the field switches.</p>
- <p>The easiest way to specify the switches is to insert and configure a table of
- contents into a Word document using the Insert->Reference->Index and Tables menu,
- then switch display of field codes on to see the switches. You can press Alt+F9 in
- Microsoft Word to toggle display of field codes on or off.</p>
- <p>For example, after creating a table of contents, the following field is inserted
- into the document: <b>{ TOC \o "1-3" \h \z \u }</b>.
- You can copy <b>\o "1-3" \h \z \u</b> and use it as the switches parameter.</p>
- <p>Note that <b>InsertTableOfContents</b> will only insert a TOC field, but
- will not actually build the table of contents. The table of contents is built by
- Microsoft Word when the field is updated.</p>
- <p>If you insert a table of contents using this method and then open the file
- in Microsoft Word, you will not see the table of contents because the TOC field
- has not yet been updated.</p>
- <p>In Microsoft Word, fields are not automatically updated when a document is opened,
- but you can update fields in a document at any time by pressing F9.</p>
- </remarks>
- <param name="switches">The TOC field switches.</param>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertField(Aspose.Words.Fields.FieldType,System.Boolean)">
- <overloads>Inserts a Word field into a document.</overloads>
- <summary>
- Inserts a Word field into a document and optionally updates the field result.
- </summary>
- <remarks>
- <para>This method inserts a field into a document.
- Aspose.Words can update fields of most types, but not all. For more details see the
- <see cref="M:Aspose.Words.DocumentBuilder.InsertField(System.String,System.String)" /> overload.</para>
- <seealso cref="T:Aspose.Words.Fields.Field" />
- </remarks>
- <param name="fieldType">The type of the field to append.</param>
- <param name="updateField">Specifies whether to update the field immediately.</param>
- <returns>A <see cref="T:Aspose.Words.Fields.Field" /> object that represents the inserted field.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertField(System.String)">
- <overloads>Inserts a Word field into a document.</overloads>
- <summary>
- Inserts a Word field into a document and updates the field result.
- </summary>
- <remarks>
- <para>This method inserts a field into a document and updates the field result immediately.
- Aspose.Words can update fields of most types, but not all. For more details see the
- <see cref="M:Aspose.Words.DocumentBuilder.InsertField(System.String,System.String)" /> overload.</para>
- <seealso cref="T:Aspose.Words.Fields.Field" />
- </remarks>
- <param name="fieldCode">The field code to insert (without curly braces).</param>
- <returns>A <see cref="T:Aspose.Words.Fields.Field" /> object that represents the inserted field.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertField(System.String,System.String)">
- <summary>
- Inserts a Word field into a document without updating the field result.
- </summary>
- <remarks>
- <p>Fields in Microsoft Word documents consist of a field code and a field result.
- The field code is like a formula and the field result is like the value that
- the formula produces. The field code may also contain field switches
- that are like additional instructions to perform a specific action.</p>
- <p>You can switch between displaying field codes and results in your document in
- Microsoft Word using the keyboard shortcut Alt+F9. Field codes appear between curly braces ( { } ).</p>
- <p>To create a field, you need to specify a field type, field code and a "placeholder" field value.
- If you are not sure about a particular field code syntax, create the field in Microsoft Word first
- and switch to see its field code.</p>
- <para>Aspose.Words can calculate field results for most of the field types, but this method
- does not update the field result automatically. Because the field result is not calculated automatically,
- you are expected to pass some string value (or even an empty string) that will be inserted into the field result.
- This value will remain in the field result as a placeholder until the field is updated.
- To update the field result you can call <see cref="M:Aspose.Words.Fields.Field.Update" /> on the field object returned
- to you or <see cref="M:Aspose.Words.Document.UpdateFields" /> to update fields in the whole document.</para>
- <seealso cref="T:Aspose.Words.Fields.Field" />
- </remarks>
- <param name="fieldCode">The field code to insert (without curly braces).</param>
- <param name="fieldValue">The field value to insert. Pass null for fields that do not have a value.</param>
- <returns>A <see cref="T:Aspose.Words.Fields.Field" /> object that represents the inserted field.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertHyperlink(System.String,System.String,System.Boolean)">
- <summary>
- Inserts a hyperlink into the document.
- </summary>
- <remarks>
- <p>Note that you need to specify font formatting for the hyperlink display text explicitly
- using the <see cref="P:Aspose.Words.DocumentBuilder.Font" /> property.</p>
- <p>This methods internally calls <see cref="M:Aspose.Words.DocumentBuilder.InsertField(System.String)" /> to insert an MS Word HYPERLINK field
- into the document.</p>
- </remarks>
- <param name="displayText">Text of the link to be displayed in the document.</param>
- <param name="urlOrBookmark">Link destination. Can be a url or a name of a bookmark inside the document.
- This method always adds apostrophes at the beginning and end of the url.</param>
- <param name="isBookmark">True if the previous parameter is a name of a bookmark inside the document;
- false is the previous parameter is a URL.</param>
- <returns>A <see cref="T:Aspose.Words.Fields.Field" /> object that represents the inserted field.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertTextInput(System.String,Aspose.Words.Fields.TextFormFieldType,System.String,System.String,System.Int32)">
- <summary>
- Inserts a text form field at the current position.
- </summary>
- <remarks>
- <p>If you specify a name for the form field, then a bookmark is automatically created with the same name.</p>
- </remarks>
- <param name="name">The name of the form field. Can be an empty string.</param>
- <param name="type">Specifies the type of the text form field.</param>
- <param name="format">Format string used to format the value of the form field.</param>
- <param name="fieldValue">Text that will be shown in the field.</param>
- <param name="maxLength">Maximum length the user can enter into the form field. Set to zero for unlimited length.</param>
- <returns>The form field node that was just inserted.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertCheckBox(System.String,System.Boolean,System.Int32)">
- <summary>
- Inserts a checkbox form field at the current position.
- </summary>
- <remarks>
- <p>If you specify a name for the form field, then a bookmark is automatically created with the same name.</p>
- </remarks>
- <param name="name">The name of the form field. Can be an empty string. The value longer than 20 characters will be truncated.</param>
- <param name="checkedValue">Checked status of the checkbox form field.</param>
- <param name="size">Specifies the size of the checkbox in points. Specify 0 for MS Word
- to calculate the size of the checkbox automatically.</param>
- <returns>The form field node that was just inserted.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertCheckBox(System.String,System.Boolean,System.Boolean,System.Int32)">
- <summary>
- Inserts a checkbox form field at the current position.
- </summary>
- <remarks>
- <p>If you specify a name for the form field, then a bookmark is automatically created with the same name.</p>
- </remarks>
- <param name="name">The name of the form field. Can be an empty string. The value longer than 20 characters will be truncated.</param>
- <param name="defaultValue">Default value of the checkbox form field.</param>
- <param name="checkedValue">Current checked status of the checkbox form field.</param>
- <param name="size">Specifies the size of the checkbox in points. Specify 0 for MS Word
- to calculate the size of the checkbox automatically.</param>
- <returns>The form field node that was just inserted.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertComboBox(System.String,System.String[],System.Int32)">
- <summary>
- Inserts a combobox form field at the current position.
- </summary>
- <remarks>
- <p>If you specify a name for the form field, then a bookmark is automatically created with the same name.</p>
- </remarks>
- <param name="name">The name of the form field. Can be an empty string. The value longer than 20 characters will be truncated.</param>
- <param name="items">The items of the ComboBox. Maximum is 25 items.</param>
- <param name="selectedIndex">The index of the selected item in the ComboBox.</param>
- <returns>The form field node that was just inserted.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertFootnote(Aspose.Words.FootnoteType,System.String)">
- <summary>
- Inserts a footnote or endnote into the document.
- </summary>
- <param name="footnoteType">Specifies whether to insert a footnote or an endnote.</param>
- <param name="footnoteText">Specifies the text of the footnote.</param>
- <returns>Returns a footnote object that was just created.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertFootnote(Aspose.Words.FootnoteType,System.String,System.String)">
- <summary>
- Inserts a footnote or endnote into the document.
- </summary>
- <param name="footnoteType">Specifies whether to insert a footnote or an endnote.</param>
- <param name="footnoteText">Specifies the text of the footnote.</param>
- <param name="referenceMark">Specifies the custom reference mark of the footnote.</param>
- <returns>Returns a footnote object that was just created.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertImage(System.Drawing.Image)">
- <overloads>Inserts an image into the document.</overloads>
- <summary>
- Inserts an image from a .NET <see cref="T:System.Drawing.Image" />
- object into the document. The image is inserted inline and at 100% scale.
- </summary>
- <param name="image">The image to insert into the document.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertImage(System.String)">
- <summary>
- Inserts an image from a file or URL into the document. The image is inserted inline and at 100% scale.
- </summary>
- <param name="fileName">The file with the image. Can be any valid local or remote URI.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>This overload will automatically download the image before inserting into the document
- if you specify a remote URI.</p>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertImage(System.IO.Stream)">
- <summary>
- Inserts an image from a stream into the document. The image is inserted inline and at 100% scale.
- </summary>
- <param name="stream">The stream that contains the image.
- </param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertImage(System.Byte[])">
- <summary>
- Inserts an image from a byte array into the document. The image is inserted inline and at 100% scale.
- </summary>
- <param name="imageBytes">The byte array that contains the image.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertImage(System.Drawing.Image,System.Double,System.Double)">
- <summary>
- Inserts an inline image from a .NET <see cref="T:System.Drawing.Image" />
- object into the document and scales it to the specified size.
- </summary>
- <param name="image">The image to insert into the document.</param>
- <param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertImage(System.String,System.Double,System.Double)">
- <summary>
- Inserts an inline image from a file or URL into the document and scales it to the specified size.
- </summary>
- <param name="fileName">The file that contains the image.</param>
- <param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertImage(System.IO.Stream,System.Double,System.Double)">
- <summary>
- Inserts an inline image from a stream into the document and scales it to the specified size.
- </summary>
- <param name="stream">The stream that contains the image.</param>
- <param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertImage(System.Byte[],System.Double,System.Double)">
- <summary>
- Inserts an inline image from a byte array into the document and scales it to the specified size.
- </summary>
- <param name="imageBytes">The byte array that contains the image.</param>
- <param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertImage(System.Drawing.Image,Aspose.Words.Drawing.RelativeHorizontalPosition,System.Double,Aspose.Words.Drawing.RelativeVerticalPosition,System.Double,System.Double,System.Double,Aspose.Words.Drawing.WrapType)">
- <summary>
- Inserts an image from a .NET <see cref="T:System.Drawing.Image" />
- object at the specified position and size.
- </summary>
- <param name="image">The image to insert into the document.</param>
- <param name="horzPos">Specifies where the distance to the image is measured from.</param>
- <param name="left">Distance in points from the origin to the left side of the image.</param>
- <param name="vertPos">Specifies where the distance to the image measured from.</param>
- <param name="top">Distance in points from the origin to the top side of the image.</param>
- <param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="wrapType">Specifies how to wrap text around the image.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertImage(System.String,Aspose.Words.Drawing.RelativeHorizontalPosition,System.Double,Aspose.Words.Drawing.RelativeVerticalPosition,System.Double,System.Double,System.Double,Aspose.Words.Drawing.WrapType)">
- <summary>
- Inserts an image from a file or URL at the specified position and size.
- </summary>
- <param name="fileName">The file that contains the image.</param>
- <param name="horzPos">Specifies where the distance to the image is measured from.</param>
- <param name="left">Distance in points from the origin to the left side of the image.</param>
- <param name="vertPos">Specifies where the distance to the image measured from.</param>
- <param name="top">Distance in points from the origin to the top side of the image.</param>
- <param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="wrapType">Specifies how to wrap text around the image.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertImage(System.IO.Stream,Aspose.Words.Drawing.RelativeHorizontalPosition,System.Double,Aspose.Words.Drawing.RelativeVerticalPosition,System.Double,System.Double,System.Double,Aspose.Words.Drawing.WrapType)">
- <summary>
- Inserts an image from a stream at the specified position and size.
- </summary>
- <param name="stream">The stream that contains the image.</param>
- <param name="horzPos">Specifies where the distance to the image is measured from.</param>
- <param name="left">Distance in points from the origin to the left side of the image.</param>
- <param name="vertPos">Specifies where the distance to the image measured from.</param>
- <param name="top">Distance in points from the origin to the top side of the image.</param>
- <param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="wrapType">Specifies how to wrap text around the image.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertImage(System.Byte[],Aspose.Words.Drawing.RelativeHorizontalPosition,System.Double,Aspose.Words.Drawing.RelativeVerticalPosition,System.Double,System.Double,System.Double,Aspose.Words.Drawing.WrapType)">
- <summary>
- Inserts an image from a byte array at the specified position and size.
- </summary>
- <param name="imageBytes">The byte array that contains the image.</param>
- <param name="horzPos">Specifies where the distance to the image is measured from.</param>
- <param name="left">Distance in points from the origin to the left side of the image.</param>
- <param name="vertPos">Specifies where the distance to the image measured from.</param>
- <param name="top">Distance in points from the origin to the top side of the image.</param>
- <param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="wrapType">Specifies how to wrap text around the image.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertOleObject(System.IO.Stream,System.String,System.Boolean,System.IO.Stream)">
- <summary>
- Inserts an embedded OLE object from a stream into the document.
- </summary>
- <param name="stream">Stream containing application data.</param>
- <param name="progId">Programmatic Identifier of OLE object.</param>
- <param name="asIcon">Specifies either Iconic or Normal mode of OLE object being inserted.</param>
- <param name="presentation">Image presentation of OLE object. If value is null Aspose.Words will use one of the predefined images.</param>
- <returns>Shape node containing Ole object and inserted at the current Builder position.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertOleObject(System.String,System.Boolean,System.Boolean,System.IO.Stream)">
- <summary>
- Inserts an embedded or linked OLE object from a file into the document. Detects OLE object type using file extension.
- </summary>
- <param name="fileName">Full path to the file.</param>
- <param name="isLinked">If true then linked OLE object is inserted otherwise embedded OLE object is inserted.</param>
- <param name="asIcon">Specifies either Iconic or Normal mode of OLE object being inserted.</param>
- <param name="presentation">Image presentation of OLE object. If value is null Aspose.Words will use one of the predefined images.</param>
- <returns>Shape node containing Ole object and inserted at the current Builder position.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertOleObject(System.String,System.String,System.Boolean,System.Boolean,System.IO.Stream)">
- <summary>
- Inserts an embedded or linked OLE object from a file into the document. Detects OLE object type using given progID parameter.
- </summary>
- <param name="fileName">Full path to the file.</param>
- <param name="progId">ProgId of OLE object.</param>
- <param name="isLinked">If true then linked OLE object is inserted otherwise embedded OLE object is inserted.</param>
- <param name="asIcon">Specifies either Iconic or Normal mode of OLE object being inserted.</param>
- <param name="presentation">Image presentation of OLE object. If value is null Aspose.Words will use one of the predefined images.</param>
- <returns>Shape node containing Ole object and inserted at the current Builder position.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertOleObjectAsIcon(System.String,System.Boolean,System.String,System.String)">
- <summary>
- Inserts an embedded or linked OLE object as icon into the document.
- Allows to specify icon file and caption. Detects OLE object type using file extension.
- </summary>
- <param name="fileName">Full path to the file.</param>
- <param name="isLinked">
- If true then linked OLE object is inserted otherwise embedded OLE object is inserted.
- </param>
- <param name="iconFile">
- Full path to the ICO file. If the value is null, Aspose.Words will use a predefined image.
- </param>
- <param name="iconCaption">Icon caption.</param>
- <returns>Shape node containing Ole object and inserted at the current Builder position.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertOleObjectAsIcon(System.String,System.String,System.Boolean,System.String,System.String)">
- <summary>
- Inserts an embedded or linked OLE object as icon into the document.
- Allows to specify icon file and caption. Detects OLE object type using given progID parameter.
- </summary>
- <param name="fileName">Full path to the file.</param>
- <param name="progId">ProgId of OLE object.</param>
- <param name="isLinked">
- If true then linked OLE object is inserted otherwise embedded OLE object is inserted.
- </param>
- <param name="iconFile">
- Full path to the ICO file. If the value is null, Aspose.Words will use a predefined image.
- </param>
- <param name="iconCaption">Icon caption.</param>
- <returns>Shape node containing Ole object and inserted at the current Builder position.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertOleObjectAsIcon(System.IO.Stream,System.String,System.String,System.String)">
- <summary>
- Inserts an embedded OLE object as icon from a stream into the document.
- Allows to specify icon file and caption. Detects OLE object type using given progID parameter.
- </summary>
- <param name="stream">Stream containing application data.</param>
- <param name="progId">ProgId of OLE object.</param>
- <param name="iconFile">
- Full path to the ICO file. If the value is null, Aspose.Words will use a predefined image.
- </param>
- <param name="iconCaption">Icon caption.</param>
- <returns>Shape node containing Ole object and inserted at the current Builder position.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertHtml(System.String)">
- <summary>
- Inserts an HTML string into the document.
- </summary>
- <remarks>
- <p>You can use InsertHtml to insert an HTML fragment or whole HTML document.</p>
- </remarks>
- <param name="html">An HTML string to insert into the document.</param>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertHtml(System.String,System.Boolean)">
- <summary>
- Inserts an HTML string into the document.
- </summary>
- <remarks>
- <p>You can use InsertHtml to insert an HTML fragment or whole HTML document.</p>
- </remarks>
- <param name="html">An HTML string to insert into the document.</param>
- <param name="useBuilderFormatting">
- A value indicating whether formatting specified in <see cref="T:Aspose.Words.DocumentBuilder" />
- is used as base formatting for text imported from HTML.
- </param>
- <remarks>
- <para>
- When <paramref name="useBuilderFormatting" /> is <c>false</c>,
- <see cref="T:Aspose.Words.DocumentBuilder" /> formating is ignored and formatting of inserted text
- is based on default HTML formatting. As a result, the text looks as it is rendered in browsers.
- </para>
- <para>
- When <paramref name="useBuilderFormatting" /> is <c>true</c>,
- formatting of inserted text is based on <see cref="T:Aspose.Words.DocumentBuilder" /> formatting,
- and the text looks as if it were inserted with <see cref="M:Aspose.Words.DocumentBuilder.Write(System.String)" />.
- </para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertShape(Aspose.Words.Drawing.ShapeType,System.Double,System.Double)">
- <summary>
- Inserts inline shape with specified type and size.
- </summary>
- <param name="shapeType">The shape type to insert into the document.</param>
- <param name="width">The width of the shape in points.</param>
- <param name="height">The height of the shape in points.</param>
- <returns>The shape node that was inserted.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertShape(Aspose.Words.Drawing.ShapeType,Aspose.Words.Drawing.RelativeHorizontalPosition,System.Double,Aspose.Words.Drawing.RelativeVerticalPosition,System.Double,System.Double,System.Double,Aspose.Words.Drawing.WrapType)">
- <summary>
- Inserts free-floating shape with specified position, size and text wrap type.
- </summary>
- <param name="shapeType">The shape type to insert into the document</param>
- <param name="horzPos">Specifies where the horizontal distance to the shape is measured from.</param>
- <param name="left">Distance in points from the origin to the left side of the shape.</param>
- <param name="vertPos">Specifies where the vertical distance to the shape is measured from.</param>
- <param name="top">Distance in points from the origin to the top side of the shape.</param>
- <param name="width">The width of the shape in points.</param>
- <param name="height">The width of the shape in points.</param>
- <param name="wrapType">Specifies how to wrap text around the shape.</param>
- <returns>The shape node that was inserted.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertChart(Aspose.Words.Drawing.Charts.ChartType,System.Double,System.Double)">
- <summary>
- Inserts an chart object into the document and scales it to the specified size.
- </summary>
- <param name="chartType">The chart type to insert into the document.</param>
- <param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertChart(Aspose.Words.Drawing.Charts.ChartType,Aspose.Words.Drawing.RelativeHorizontalPosition,System.Double,Aspose.Words.Drawing.RelativeVerticalPosition,System.Double,System.Double,System.Double,Aspose.Words.Drawing.WrapType)">
- <summary>
- Inserts an chart object into the document and scales it to the specified size.
- </summary>
- <param name="chartType">The chart type to insert into the document.</param>
- <param name="horzPos">Specifies where the distance to the image is measured from.</param>
- <param name="left">Distance in points from the origin to the left side of the image.</param>
- <param name="vertPos">Specifies where the distance to the image measured from.</param>
- <param name="top">Distance in points from the origin to the top side of the image.</param>
- <param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="wrapType">Specifies how to wrap text around the image.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertOnlineVideo(System.String,System.Double,System.Double)">
- <summary>
- Inserts an online video object into the document and scales it to the specified size.
- </summary>
- <param name="videoUrl">The URL to the video.</param>
- <param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- <para>Insertion of online video from the following resources is supported:</para>
- <list type="bullet">
- <item>
- <description>https://www.youtube.com/</description>
- </item>
- <item>
- <description>https://vimeo.com/</description>
- </item>
- </list>
- <para>If your online video is not displaying correctly, use <see cref="M:Aspose.Words.DocumentBuilder.InsertOnlineVideo(System.String,System.String,System.Byte[],System.Double,System.Double)" />, which accepts custom embedded html code.</para>
- <para>The code for embedding video can vary between providers, consult your corresponding provider of choice for details.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertOnlineVideo(System.String,Aspose.Words.Drawing.RelativeHorizontalPosition,System.Double,Aspose.Words.Drawing.RelativeVerticalPosition,System.Double,System.Double,System.Double,Aspose.Words.Drawing.WrapType)">
- <summary>
- Inserts an online video object into the document and scales it to the specified size.
- </summary>
- <param name="videoUrl">The URL to the video.</param>
- <param name="horzPos">Specifies where the distance to the image is measured from.</param>
- <param name="left">Distance in points from the origin to the left side of the image.</param>
- <param name="vertPos">Specifies where the distance to the image measured from.</param>
- <param name="top">Distance in points from the origin to the top side of the image.</param>
- <param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="wrapType">Specifies how to wrap text around the image.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- <para>Insertion of online video from the following resources is supported:</para>
- <list type="bullet">
- <item>
- <description>https://www.youtube.com/</description>
- </item>
- <item>
- <description>https://vimeo.com/</description>
- </item>
- </list>
- <para>If your online video is not displaying correctly, use <see cref="M:Aspose.Words.DocumentBuilder.InsertOnlineVideo(System.String,System.String,System.Byte[],System.Double,System.Double)" />, which accepts custom embedded html code.</para>
- <para>The code for embedding video can vary between providers, consult your corresponding provider of choice for details.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertOnlineVideo(System.String,System.String,System.Byte[],System.Double,System.Double)">
- <summary>
- Inserts an online video object into the document and scales it to the specified size.
- </summary>
- <param name="videoUrl">The URL to the video.</param>
- <param name="videoEmbedCode">The embed code for the video.</param>
- <param name="thumbnailImageBytes">The thumbnail image bytes.</param>
- <param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertOnlineVideo(System.String,System.String,System.Byte[],Aspose.Words.Drawing.RelativeHorizontalPosition,System.Double,Aspose.Words.Drawing.RelativeVerticalPosition,System.Double,System.Double,System.Double,Aspose.Words.Drawing.WrapType)">
- <summary>
- Inserts an online video object into the document and scales it to the specified size.
- </summary>
- <param name="videoUrl">The URL to the video.</param>
- <param name="videoEmbedCode">The embed code for the video.</param>
- <param name="thumbnailImageBytes">The thumbnail image bytes.</param>
- <param name="horzPos">Specifies where the distance to the image is measured from.</param>
- <param name="left">Distance in points from the origin to the left side of the image.</param>
- <param name="vertPos">Specifies where the distance to the image measured from.</param>
- <param name="top">Distance in points from the origin to the top side of the image.</param>
- <param name="width">The width of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="height">The height of the image in points. Can be a negative or zero value to request 100% scale.</param>
- <param name="wrapType">Specifies how to wrap text around the image.</param>
- <returns>The image node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertSignatureLine(Aspose.Words.SignatureLineOptions)">
- <summary>
- Inserts a signature line at the current position.
- </summary>
- <param name="signatureLineOptions">The object that stores parameters of creating signature line.</param>
- <returns>The signature line node that was just inserted.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertSignatureLine(Aspose.Words.SignatureLineOptions,Aspose.Words.Drawing.RelativeHorizontalPosition,System.Double,Aspose.Words.Drawing.RelativeVerticalPosition,System.Double,Aspose.Words.Drawing.WrapType)">
- <summary>
- Inserts a signature line at the specified position.
- </summary>
- <param name="signatureLineOptions">The object that stores parameters of creating signature line.</param>
- <param name="horzPos">Specifies where the distance to the signature line is measured from.</param>
- <param name="left">Distance in points from the origin to the left side of the signature line.</param>
- <param name="vertPos">Specifies where the distance to the signature line measured from.</param>
- <param name="top">Distance in points from the origin to the top side of the signature line.</param>
- <param name="wrapType">Specifies how to wrap text around the signature line.</param>
- <returns>The signature line node that was just inserted.</returns>
- <remarks>
- <p>You can change the image size, location, positioning method and other settings using the
- <see cref="T:Aspose.Words.Drawing.Shape" /> object returned by this method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertHorizontalRule">
- <summary>
- Inserts a horizontal rule shape into the document.
- </summary>
- <returns>The shape that is a horizontal rule.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertHtml(System.String,Aspose.Words.HtmlInsertionOptions)">
- <summary>
- Inserts an HTML string into the document. Allows to specify additional options.
- </summary>
- <remarks>
- <p>You can use InsertHtml to insert an HTML fragment or whole HTML document.</p>
- </remarks>
- <param name="html">An HTML string to insert into the document.</param>
- <param name="options">Additional options to use when inserting the HTML string. Can be <c>null</c>.</param>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertCell">
- <summary>
- Inserts a table cell into the document.
- </summary>
- <remarks>
- <p>To start a table, just call <b>InsertCell</b>. After this, any content you add using
- other methods of the <see cref="T:Aspose.Words.DocumentBuilder" /> class will be added to the current cell.</p>
- <p>To start a new cell in the same row, call <b>InsertCell</b> again.</p>
- <p>To end a table row call <see cref="M:Aspose.Words.DocumentBuilder.EndRow" />.</p>
- <p>Use the <see cref="P:Aspose.Words.DocumentBuilder.CellFormat" /> property to specify cell formatting.</p>
- </remarks>
- <returns>The cell node that was just inserted.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.StartTable">
- <summary>
- Starts a table in the document.
- </summary>
- <remarks>
- <p>The next method to call is <see cref="M:Aspose.Words.DocumentBuilder.InsertCell" />.</p>
- <p>This method starts a nested table when called inside a cell.</p>
- </remarks>
- <returns>The table node that was just created.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.EndTable">
- <summary>
- Ends a table in the document.
- </summary>
- <remarks>
- <p>This method should be called only once after <see cref="M:Aspose.Words.DocumentBuilder.EndRow" /> was called. When called,
- <b>EndTable</b> moves the cursor out of the current cell to point just after the table.</p>
- </remarks>
- <returns>The table node that was just finished.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.EndRow">
- <summary>
- Ends a table row in the document.
- </summary>
- <remarks>
- <p>Call <b>EndRow</b> to end a table row. If you call <see cref="M:Aspose.Words.DocumentBuilder.InsertCell" /> immediately
- after that, then the table continues on a new row.</p>
- <p>Use the <see cref="P:Aspose.Words.DocumentBuilder.RowFormat" /> property to specify row formatting.</p>
- </remarks>
- <returns>The row node that was just finished.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.StartBookmark(System.String)">
- <summary>
- Marks the current position in the document as a bookmark start.
- </summary>
- <remarks>
- <p>Bookmarks in a document can overlap and span any range. To create a valid bookmark you need to
- call both <see cref="M:Aspose.Words.DocumentBuilder.StartBookmark(System.String)" /> and <see cref="M:Aspose.Words.DocumentBuilder.EndBookmark(System.String)" /> with the same <b>bookmarkName</b>
- parameter.</p>
- <p>Badly formed bookmarks or bookmarks with duplicate names will be ignored when the document is saved.</p>
- </remarks>
- <param name="bookmarkName">Name of the bookmark.</param>
- <returns>The bookmark start node that was just created.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.EndBookmark(System.String)">
- <summary>
- Marks the current position in the document as a bookmark end.
- </summary>
- <remarks>
- <p>Bookmarks in a document can overlap and span any range. To create a valid bookmark you need to
- call both <see cref="M:Aspose.Words.DocumentBuilder.StartBookmark(System.String)" /> and <see cref="M:Aspose.Words.DocumentBuilder.EndBookmark(System.String)" /> with the same <b>bookmarkName</b>
- parameter.</p>
- <p>Badly formed bookmarks or bookmarks with duplicate names will be ignored when the document is saved.</p>
- </remarks>
- <param name="bookmarkName">Name of the bookmark.</param>
- <returns>The bookmark end node that was just created.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.StartEditableRange">
- <summary>
- Marks the current position in the document as an editable range start.
- </summary>
- <remarks>
- <p>Editable range in a document can overlap and span any range. To create a valid editable range you need to
- call both <see cref="M:Aspose.Words.DocumentBuilder.StartEditableRange" /> and <see cref="M:Aspose.Words.DocumentBuilder.EndEditableRange" />
- or <see cref="M:Aspose.Words.DocumentBuilder.EndEditableRange(Aspose.Words.EditableRangeStart)" /> methods.</p>
- <p>Badly formed editable range will be ignored when the document is saved.</p>
- </remarks>
- <returns>The editable range start node that was just created.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.EndEditableRange">
- <summary>
- Marks the current position in the document as an editable range end.
- </summary>
- <remarks>
- <p>Editable range in a document can overlap and span any range. To create a valid editable range you need to
- call both <see cref="M:Aspose.Words.DocumentBuilder.StartEditableRange" /> and <see cref="M:Aspose.Words.DocumentBuilder.EndEditableRange" />
- or <see cref="M:Aspose.Words.DocumentBuilder.EndEditableRange(Aspose.Words.EditableRangeStart)" /> methods.</p>
- <p>Badly formed editable range will be ignored when the document is saved.</p>
- </remarks>
- <returns>The editable range end node that was just created.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.EndEditableRange(Aspose.Words.EditableRangeStart)">
- <summary>
- Marks the current position in the document as an editable range end.
- </summary>
- <remarks>
- <p>Use this overload during creating nested editable ranges.</p>
- <p>Editable range in a document can overlap and span any range. To create a valid editable range you need to
- call both <see cref="M:Aspose.Words.DocumentBuilder.StartEditableRange" /> and <see cref="M:Aspose.Words.DocumentBuilder.EndEditableRange" />
- or <see cref="M:Aspose.Words.DocumentBuilder.EndEditableRange(Aspose.Words.EditableRangeStart)" /> methods.</p>
- <p>Badly formed editable range will be ignored when the document is saved.</p>
- </remarks>
- <param name="start">This editable range start.</param>
- <returns>The editable range end node that was just created.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertDocument(Aspose.Words.Document,Aspose.Words.ImportFormatMode)">
- <summary>
- Inserts a document at the cursor position.
- </summary>
- <remarks>
- This method mimics the MS Word behavior, as if CTRL+'A' (select all content) was pressed,
- then CTRL+'C' (copy selected into the buffer) inside one document
- and then CTRL+'V' (insert content from the buffer) inside another document.
- </remarks>
- <param name="srcDoc">Source document for inserting.</param>
- <param name="importFormatMode">Specifies how to merge style formatting that clashes.</param>
- <returns>First node of the inserted content.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertDocument(Aspose.Words.Document,Aspose.Words.ImportFormatMode,Aspose.Words.ImportFormatOptions)">
- <summary>
- Inserts a document at the cursor position.
- </summary>
- <remarks>
- This method mimics the MS Word behavior, as if CTRL+'A' (select all content) was pressed,
- then CTRL+'C' (copy selected into the buffer) inside one document
- and then CTRL+'V' (insert content from the buffer) inside another document.
- </remarks>
- <param name="srcDoc">Source document for inserting.</param>
- <param name="importFormatMode">Specifies how to merge style formatting that clashes.</param>
- <param name="importFormatOptions">Allows to specify options that affect formatting of a result document.</param>
- <returns>First node of the inserted content.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.PushFont">
- <summary>
- Saves current character formatting onto the stack.
- </summary>
- <seealso cref="P:Aspose.Words.DocumentBuilder.Font" />
- <seealso cref="M:Aspose.Words.DocumentBuilder.PopFont" />
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.PopFont">
- <summary>
- Retrieves character formatting previously saved on the stack.
- </summary>
- <seealso cref="P:Aspose.Words.DocumentBuilder.Font" />
- <seealso cref="M:Aspose.Words.DocumentBuilder.PushFont" />
- </member>
- <member name="M:Aspose.Words.DocumentBuilder.InsertNode(Aspose.Words.Node)">
- <summary>
- Inserts a text level node inside the current paragraph before the cursor.
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.Document">
- <summary>
- Gets or sets the <see cref="P:Aspose.Words.DocumentBuilder.Document" /> object that this object is attached to.
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.Font">
- <summary>
- Returns an object that represents current font formatting properties.
- </summary>
- <remarks>
- <p>Use <b>Font</b> to access and modify font formatting properties.</p>
- <p>Specify font formatting before inserting text.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.Bold">
- <summary>
- True if the font is formatted as bold.
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.Italic">
- <summary>
- True if the font is formatted as italic.
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.Underline">
- <summary>
- Gets/sets underline type for the current font.
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.ParagraphFormat">
- <summary>
- Returns an object that represents current paragraph formatting properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.ListFormat">
- <summary>
- Returns an object that represents current list formatting properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.PageSetup">
- <summary>
- Returns an object that represents current page setup and section properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.RowFormat">
- <summary>
- Returns an object that represents current table row formatting properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.CellFormat">
- <summary>
- Returns an object that represents current table cell formatting properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.IsAtStartOfParagraph">
- <summary>
- Returns true if the cursor is at the beginning of the current paragraph (no text before the cursor).
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.IsAtEndOfParagraph">
- <summary>
- Returns true if the cursor is at the end of the current paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.CurrentNode">
- <summary>
- Gets the node that is currently selected in this DocumentBuilder.
- </summary>
- <remarks>
- <p>
- <b>CurrentNode</b> is a cursor of <b>DocumentBuilder</b> and points to a <b>Node</b>
- that is a direct child of a <b>Paragraph</b>. Any insert operations you perform using
- <b>DocumentBuilder</b> will insert before the <b>CurrentNode</b>.</p>
- <p>When the current paragraph is empty or the cursor is positioned just
- before the end of the paragraph, <b>CurrentNode</b> returns null.</p>
- <seealso cref="P:Aspose.Words.DocumentBuilder.CurrentParagraph" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.CurrentParagraph">
- <summary>
- Gets the paragraph that is currently selected in this DocumentBuilder.
- </summary>
- <remarks>
- <see cref="P:Aspose.Words.DocumentBuilder.CurrentNode" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.CurrentStory">
- <summary>
- Gets the story that is currently selected in this DocumentBuilder.
- </summary>
- </member>
- <member name="P:Aspose.Words.DocumentBuilder.CurrentSection">
- <summary>
- Gets the section that is currently selected in this DocumentBuilder.
- </summary>
- </member>
- <member name="T:Aspose.Words.DocumentVisitor">
- <summary>
- Base class for custom document visitors.
- </summary>
- <remarks>
- <p>With <b>DocumentVisitor</b> you can define and execute custom operations
- that require enumeration over the document tree.</p>
- <p>For example, Aspose.Words uses <b>DocumentVisitor</b> internally for saving <b>Document</b>
- in various formats and for other operations like finding fields or bookmarks over
- a fragment of a document.</p>
- <p>To use <b>DocumentVisitor</b>:</p>
- <list type="number">
- <item>Create a class derived from <b>DocumentVisitor</b>.</item>
- <item>Override and provide implementations for some or all of the VisitXXX methods
- to perform some custom operations.</item>
- <item>Call <see cref="M:Aspose.Words.Node.Accept(Aspose.Words.DocumentVisitor)">Node.Accept</see> on the <b>Node</b> that
- you want to start the enumeration from.</item>
- </list>
- <p>
- <b>DocumentVisitor</b> provides default implementations for all of the VisitXXX methods
- to make it easier to create new document visitors as only the methods required for the particular
- visitor need to be overridden. It is not necessary to override all of the visitor methods.</p>
- <p>For more information see the Visitor design pattern.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitDocumentStart(Aspose.Words.Document)">
- <summary>
- Called when enumeration of the document has started.
- </summary>
- <param name="doc">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitDocumentEnd(Aspose.Words.Document)">
- <summary>
- Called when enumeration of the document has finished.
- </summary>
- <param name="doc">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitSectionStart(Aspose.Words.Section)">
- <summary>
- Called when enumeration of a section has started.
- </summary>
- <param name="section">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitSectionEnd(Aspose.Words.Section)">
- <summary>
- Called when enumeration of a section has ended.
- </summary>
- <param name="section">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitBodyStart(Aspose.Words.Body)">
- <summary>
- Called when enumeration of the main text story in a section has started.
- </summary>
- <param name="body">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitBodyEnd(Aspose.Words.Body)">
- <summary>
- Called when enumeration of the main text story in a section has ended.
- </summary>
- <param name="body">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitHeaderFooterStart(Aspose.Words.HeaderFooter)">
- <summary>
- Called when enumeration of a header or footer in a section has started.
- </summary>
- <param name="headerFooter">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitHeaderFooterEnd(Aspose.Words.HeaderFooter)">
- <summary>
- Called when enumeration of a header or footer in a section has ended.
- </summary>
- <param name="headerFooter">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitParagraphStart(Aspose.Words.Paragraph)">
- <summary>
- Called when enumeration of a paragraph has started.
- </summary>
- <param name="paragraph">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitParagraphEnd(Aspose.Words.Paragraph)">
- <summary>
- Called when enumeration of a paragraph has ended.
- </summary>
- <param name="paragraph">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitTableStart(Aspose.Words.Tables.Table)">
- <summary>
- Called when enumeration of a table has started.
- </summary>
- <param name="table">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitTableEnd(Aspose.Words.Tables.Table)">
- <summary>
- Called when enumeration of a table has ended.
- </summary>
- <param name="table">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitRowStart(Aspose.Words.Tables.Row)">
- <summary>
- Called when enumeration of a table row has started.
- </summary>
- <param name="row">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitRowEnd(Aspose.Words.Tables.Row)">
- <summary>
- Called when enumeration of a table row has ended.
- </summary>
- <param name="row">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitCellStart(Aspose.Words.Tables.Cell)">
- <summary>
- Called when enumeration of a table cell has started.
- </summary>
- <param name="cell">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitCellEnd(Aspose.Words.Tables.Cell)">
- <summary>
- Called when enumeration of a table cell has ended.
- </summary>
- <param name="cell">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitRun(Aspose.Words.Run)">
- <summary>
- Called when a run of text in the is encountered.
- </summary>
- <param name="run">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitFieldStart(Aspose.Words.Fields.FieldStart)">
- <summary>
- Called when a field starts in the document.
- </summary>
- <remarks>
- <p>A field in a Word Word document consists of a field code and field value.</p>
- <p>For example, a field that displays a page number can be represented as follows:</p>
- <p>[FieldStart]PAGE[FieldSeparator]98[FieldEnd]</p>
- <p>The field separator separates field code from field value in the document. Note that some
- fields have only field code and do not have field separator and field value.</p>
- <p>Fields can be nested.</p>
- </remarks>
- <param name="fieldStart">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitFieldSeparator(Aspose.Words.Fields.FieldSeparator)">
- <summary>
- Called when a field separator is encountered in the document.
- </summary>
- <remarks>
- <p>The field separator separates field code from field value in the document. Note that some
- fields have only field code and do not have field separator and field value.</p>
- <p>For more info see <see cref="M:Aspose.Words.DocumentVisitor.VisitFieldStart(Aspose.Words.Fields.FieldStart)" /></p>
- </remarks>
- <param name="fieldSeparator">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitFieldEnd(Aspose.Words.Fields.FieldEnd)">
- <summary>
- Called when a field ends in the document.
- </summary>
- <remarks>
- <p>For more info see <see cref="M:Aspose.Words.DocumentVisitor.VisitFieldStart(Aspose.Words.Fields.FieldStart)" /></p>
- </remarks>
- <param name="fieldEnd">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitFormField(Aspose.Words.Fields.FormField)">
- <summary>
- Called when a form field is encountered in the document.
- </summary>
- <param name="formField">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitBookmarkStart(Aspose.Words.BookmarkStart)">
- <summary>
- Called when a start of a bookmark is encountered in the document.
- </summary>
- <param name="bookmarkStart">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitBookmarkEnd(Aspose.Words.BookmarkEnd)">
- <summary>
- Called when an end of a bookmark is encountered in the document.
- </summary>
- <param name="bookmarkEnd">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitFootnoteStart(Aspose.Words.Footnote)">
- <summary>
- Called when enumeration of a footnote or endnote text has started.
- </summary>
- <param name="footnote">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitFootnoteEnd(Aspose.Words.Footnote)">
- <summary>
- Called when enumeration of a footnote or endnote text has ended.
- </summary>
- <param name="footnote">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitCommentStart(Aspose.Words.Comment)">
- <summary>
- Called when enumeration of a comment text has started.
- </summary>
- <param name="comment">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitCommentEnd(Aspose.Words.Comment)">
- <summary>
- Called when enumeration of a comment text has ended.
- </summary>
- <param name="comment">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitEditableRangeStart(Aspose.Words.EditableRangeStart)">
- <summary>
- Called when a start of an editable range is encountered in the document.
- </summary>
- <param name="editableRangeStart">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitEditableRangeEnd(Aspose.Words.EditableRangeEnd)">
- <summary>
- Called when an end of an editable range is encountered in the document.
- </summary>
- <param name="editableRangeEnd">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitShapeStart(Aspose.Words.Drawing.Shape)">
- <summary>
- Called when enumeration of a shape has started.
- </summary>
- <param name="shape">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitShapeEnd(Aspose.Words.Drawing.Shape)">
- <summary>
- Called when enumeration of a shape has ended.
- </summary>
- <param name="shape">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitGroupShapeStart(Aspose.Words.Drawing.GroupShape)">
- <summary>
- Called when enumeration of a group shape has started.
- </summary>
- <param name="groupShape">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitGroupShapeEnd(Aspose.Words.Drawing.GroupShape)">
- <summary>
- Called when enumeration of a group shape has ended.
- </summary>
- <param name="groupShape">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitOfficeMathStart(Aspose.Words.Math.OfficeMath)">
- <summary>
- Called when enumeration of a Office Math object has started.
- </summary>
- <param name="officeMath">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitOfficeMathEnd(Aspose.Words.Math.OfficeMath)">
- <summary>
- Called when enumeration of a Office Math object has ended.
- </summary>
- <param name="officeMath">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitSpecialChar(Aspose.Words.SpecialChar)">
- <summary>
- Called when a <see cref="T:Aspose.Words.SpecialChar" /> node is encountered in the document.
- </summary>
- <param name="specialChar">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- <remarks>
- This method is not be called for generic control characters (see <see cref="T:Aspose.Words.ControlChar" />) that can be present in the document.
- </remarks>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitAbsolutePositionTab(Aspose.Words.AbsolutePositionTab)">
- <summary>
- Called when a <see cref="T:Aspose.Words.AbsolutePositionTab" /> node is encountered in the document.
- </summary>
- <param name="tab">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitSmartTagStart(Aspose.Words.Markup.SmartTag)">
- <summary>
- Called when enumeration of a smart tag has started.
- </summary>
- <param name="smartTag">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitSmartTagEnd(Aspose.Words.Markup.SmartTag)">
- <summary>
- Called when enumeration of a smart tag has ended.
- </summary>
- <param name="smartTag">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitStructuredDocumentTagStart(Aspose.Words.Markup.StructuredDocumentTag)">
- <summary>
- Called when enumeration of a structured document tag has started.
- </summary>
- <param name="sdt">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitStructuredDocumentTagEnd(Aspose.Words.Markup.StructuredDocumentTag)">
- <summary>
- Called when enumeration of a structured document tag has ended.
- </summary>
- <param name="sdt">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitGlossaryDocumentStart(Aspose.Words.BuildingBlocks.GlossaryDocument)">
- <summary>
- Called when enumeration of a glossary document has started.
- </summary>
- <remarks>
- <para>
- Note: A glossary document node and its children are not visited when you execute a
- Visitor over a <see cref="T:Aspose.Words.Document" />. If you want to execute a Visitor over a
- glossary document, you need to call <see cref="M:Aspose.Words.BuildingBlocks.GlossaryDocument.Accept(Aspose.Words.DocumentVisitor)" />.
- </para>
- </remarks>
- <param name="glossary">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitGlossaryDocumentEnd(Aspose.Words.BuildingBlocks.GlossaryDocument)">
- <summary>
- Called when enumeration of a glossary document has ended.
- </summary>
- <remarks>
- <para>
- Note: A glossary document node and its children are not visited when you execute a
- Visitor over a <see cref="T:Aspose.Words.Document" />. If you want to execute a Visitor over a
- glossary document, you need to call <see cref="M:Aspose.Words.BuildingBlocks.GlossaryDocument.Accept(Aspose.Words.DocumentVisitor)" />.
- </para>
- </remarks>
- <param name="glossary">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitBuildingBlockStart(Aspose.Words.BuildingBlocks.BuildingBlock)">
- <summary>
- Called when enumeration of a building block has started.
- </summary>
- <remarks>
- <para>
- Note: A building block node and its children are not visited when you execute a
- Visitor over a <see cref="T:Aspose.Words.Document" />. If you want to execute a Visitor over a
- building block, you need to execute the visitor over <see cref="T:Aspose.Words.BuildingBlocks.GlossaryDocument" /> or
- call <see cref="M:Aspose.Words.BuildingBlocks.BuildingBlock.Accept(Aspose.Words.DocumentVisitor)" />.
- </para>
- </remarks>
- <param name="block">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitBuildingBlockEnd(Aspose.Words.BuildingBlocks.BuildingBlock)">
- <summary>
- Called when enumeration of a building block has ended.
- </summary>
- <remarks>
- <para>
- Note: A building block node and its children are not visited when you execute a
- Visitor over a <see cref="T:Aspose.Words.Document" />. If you want to execute a Visitor over a
- building block, you need to execute the visitor over <see cref="T:Aspose.Words.BuildingBlocks.GlossaryDocument" /> or
- call <see cref="M:Aspose.Words.BuildingBlocks.BuildingBlock.Accept(Aspose.Words.DocumentVisitor)" />.
- </para>
- </remarks>
- <param name="block">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitCommentRangeStart(Aspose.Words.CommentRangeStart)">
- <summary>
- Called when the start of a commented range of text is encountered.
- </summary>
- <param name="commentRangeStart">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitCommentRangeEnd(Aspose.Words.CommentRangeEnd)">
- <summary>
- Called when the end of a commented range of text is encountered.
- </summary>
- <param name="commentRangeEnd">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="M:Aspose.Words.DocumentVisitor.VisitSubDocument(Aspose.Words.SubDocument)">
- <summary>
- Called when a subDocument is encountered.
- </summary>
- <param name="subDocument">The object that is being visited.</param>
- <returns>A <see cref="T:Aspose.Words.VisitorAction" /> value that specifies how to continue the enumeration.</returns>
- </member>
- <member name="T:Aspose.Words.IncorrectPasswordException">
- <summary>
- Thrown if a document is encrypted with a password and the password specified when opening the document is incorrect or missing.
- </summary>
- </member>
- <member name="T:Aspose.Words.FileCorruptedException">
- <summary>
- Thrown during document load, when the document appears to be corrupted and impossible to load.
- </summary>
- </member>
- <member name="T:Aspose.Words.FileFormatUtil">
- <summary>
- Provides utility methods for working with file formats, such as detecting file format
- or converting file extensions to/from file format enums.
- </summary>
- </member>
- <member name="M:Aspose.Words.FileFormatUtil.DetectFileFormat(System.String)">
- <overloads>Detects and returns the information about a format of a document.</overloads>
- <summary>
- Detects and returns the information about a format of a document stored in a disk file.
- </summary>
- <remarks>
- <para>Even if this method detects the document format, it does not guarantee
- that the specified document is valid. This method only detects the document format by
- reading data that is sufficient for detection. To fully verify that a document is valid
- you need to load the document into a <see cref="T:Aspose.Words.Document" /> object.</para>
- <para>This method throws <see cref="T:Aspose.Words.FileCorruptedException" /> when the format is
- recognized, but the detection cannot complete because of corruption.</para>
- </remarks>
- <param name="fileName">The file name.</param>
- <returns>A <see cref="T:Aspose.Words.FileFormatInfo" /> object that contains the detected information.</returns>
- </member>
- <member name="M:Aspose.Words.FileFormatUtil.DetectFileFormat(System.IO.Stream)">
- <summary>
- Detects and returns the information about a format of a document stored in a stream.
- </summary>
- <remarks>
- <para>The stream must be positioned at the beginning of the document.</para>
- <para>When this method returns, the position in the stream is restored to the original position.</para>
- <para>Even if this method detects the document format, it does not guarantee
- that the specified document is valid. This method only detects the document format by
- reading data that is sufficient for detection. To fully verify that a document is valid
- you need to load the document into a <see cref="T:Aspose.Words.Document" /> object.</para>
- <para>This method throws <see cref="T:Aspose.Words.FileCorruptedException" /> when the format is
- recognized, but the detection cannot complete because of corruption.</para>
- </remarks>
- <param name="stream">The stream.</param>
- <returns>A <see cref="T:Aspose.Words.FileFormatInfo" /> object that contains the detected information.</returns>
- </member>
- <member name="M:Aspose.Words.FileFormatUtil.ContentTypeToLoadFormat(System.String)">
- <summary>
- Converts IANA content type into a load format enumerated value.
- </summary>
- <exception cref="T:System.ArgumentException">Throws when cannot convert.</exception>
- </member>
- <member name="M:Aspose.Words.FileFormatUtil.ContentTypeToSaveFormat(System.String)">
- <summary>
- Converts IANA content type into a save format enumerated value.
- </summary>
- <exception cref="T:System.ArgumentException">Throws when cannot convert.</exception>
- </member>
- <member name="M:Aspose.Words.FileFormatUtil.LoadFormatToExtension(Aspose.Words.LoadFormat)">
- <summary>
- Converts a load format enumerated value into a file extension. The returned extension is a lower-case string with a leading dot.
- </summary>
- <remarks>
- <para>The <see cref="F:Aspose.Words.SaveFormat.WordML" /> value is converted to ".wml".</para>
- </remarks>
- <exception cref="T:System.ArgumentException">Throws when cannot convert.</exception>
- </member>
- <member name="M:Aspose.Words.FileFormatUtil.SaveFormatToLoadFormat(Aspose.Words.SaveFormat)">
- <summary>
- Converts a <see cref="T:Aspose.Words.SaveFormat" /> value to a <see cref="T:Aspose.Words.LoadFormat" /> value if possible.
- </summary>
- <exception cref="T:System.ArgumentException">Throws when cannot convert.</exception>
- </member>
- <member name="M:Aspose.Words.FileFormatUtil.LoadFormatToSaveFormat(Aspose.Words.LoadFormat)">
- <summary>
- Converts a <see cref="T:Aspose.Words.LoadFormat" /> value to a <see cref="T:Aspose.Words.SaveFormat" /> value if possible.
- </summary>
- <exception cref="T:System.ArgumentException">Throws when cannot convert.</exception>
- </member>
- <member name="M:Aspose.Words.FileFormatUtil.SaveFormatToExtension(Aspose.Words.SaveFormat)">
- <summary>
- Converts a save format enumerated value into a file extension. The returned extension is a lower-case string with a leading dot.
- </summary>
- <remarks>
- <para>The <see cref="F:Aspose.Words.SaveFormat.WordML" /> value is converted to ".wml".</para>
- <para>The <see cref="F:Aspose.Words.SaveFormat.FlatOpc" /> value is converted to ".fopc".</para>
- </remarks>
- <exception cref="T:System.ArgumentException">Throws when cannot convert.</exception>
- </member>
- <member name="M:Aspose.Words.FileFormatUtil.ExtensionToSaveFormat(System.String)">
- <summary>
- Converts a file name extension into a <see cref="T:Aspose.Words.SaveFormat" /> value.
- </summary>
- <param name="extension">The file extension. Can be with or without a leading dot. Case-insensitive.</param>
- <remarks>
- <p>If the extension cannot be recognized, returns <see cref="F:Aspose.Words.SaveFormat.Unknown" />.</p>
- </remarks>
- <exception cref="T:System.ArgumentNullException">Throws if the parameter is null.</exception>
- </member>
- <member name="M:Aspose.Words.FileFormatUtil.ImageTypeToExtension(Aspose.Words.Drawing.ImageType)">
- <summary>
- Converts an Aspose.Words image type enumerated value into a file extension. The returned extension is a lower-case string with a leading dot.
- </summary>
- <exception cref="T:System.ArgumentException">Throws when cannot convert.</exception>
- </member>
- <member name="T:Aspose.Words.LoadFormat">
- <summary>
- Indicates the format of the document that is to be loaded.
- </summary>
- <dev>
- We should only use values 0..255 here because these values are used as bit flags in the UnifiedScenario enum.
- </dev>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Auto">
- <summary>
- Instructs Aspose.Words to recognize the format automatically.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Doc">
- <summary>
- Microsoft Word 95 or Word 97 - 2003 Document.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Dot">
- <summary>
- Microsoft Word 95 or Word 97 - 2003 Template.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.DocPreWord60">
- <summary>
- The document is in pre-Word 95 format.
- Aspose.Words does not currently support loading such documents.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Docx">
- <summary>
- Office Open XML WordprocessingML Document (macro-free).
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Docm">
- <summary>
- Office Open XML WordprocessingML Macro-Enabled Document.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Dotx">
- <summary>
- Office Open XML WordprocessingML Template (macro-free).
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Dotm">
- <summary>
- Office Open XML WordprocessingML Macro-Enabled Template.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.FlatOpc">
- <summary>
- Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.FlatOpcMacroEnabled">
- <summary>
- Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.FlatOpcTemplate">
- <summary>
- Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.FlatOpcTemplateMacroEnabled">
- <summary>
- Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Rtf">
- <summary>
- RTF format.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.WordML">
- <summary>
- Microsoft Word 2003 WordprocessingML format.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Html">
- <summary>
- HTML format.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Mhtml">
- <summary>
- MHTML (Web archive) format.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Mobi">
- <summary>
- MOBI is an eBook format used by the MobiPocket Reader and Amazon Kindle Readers.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Chm">
- <summary>
- CHM (Compiled HTML Help) format.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Odt">
- <summary>
- ODF Text Document.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Ott">
- <summary>
- ODF Text Document Template.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Text">
- <summary>
- Plain Text.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Markdown">
- <summary>
- Markdown text document.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Pdf">
- <summary>
- Pdf document.
- </summary>
- </member>
- <member name="F:Aspose.Words.LoadFormat.Unknown">
- <summary>
- Unrecognized format, cannot be loaded by Aspose.Words.
- </summary>
- </member>
- <member name="T:Aspose.Words.FootnoteNumberingRule">
- <summary>
- Determines when automatic footnote or endnote numbering restarts.
- </summary>
- <seealso cref="T:Aspose.Words.FootnoteOptions" />
- <seealso cref="T:Aspose.Words.EndnoteOptions" />
- </member>
- <member name="F:Aspose.Words.FootnoteNumberingRule.Continuous">
- <summary>
- Numbering continuous throughout the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.FootnoteNumberingRule.RestartSection">
- <summary>
- Numbering restarts at each section.
- </summary>
- </member>
- <member name="F:Aspose.Words.FootnoteNumberingRule.RestartPage">
- <summary>
- Numbering restarts at each page. Valid for footnotes only.
- </summary>
- </member>
- <member name="F:Aspose.Words.FootnoteNumberingRule.Default">
- <summary>
- Equals <see cref="F:Aspose.Words.FootnoteNumberingRule.Continuous" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.FootnotePosition">
- <summary>
- Defines the footnote position.
- </summary>
- <seealso cref="T:Aspose.Words.FootnoteOptions" />
- </member>
- <member name="F:Aspose.Words.FootnotePosition.BottomOfPage">
- <summary>
- Footnotes are output at the bottom of each page.
- </summary>
- </member>
- <member name="F:Aspose.Words.FootnotePosition.BeneathText">
- <summary>
- Footnotes are output beneath text on each page.
- </summary>
- </member>
- <member name="T:Aspose.Words.FootnoteOptions">
- <summary>
- Represents the footnote numbering options for a document or section.
- </summary>
- <seealso cref="P:Aspose.Words.Document.FootnoteOptions" />
- <seealso cref="P:Aspose.Words.PageSetup.FootnoteOptions" />
- </member>
- <member name="P:Aspose.Words.FootnoteOptions.Position">
- <summary>
- Specifies the footnotes position.
- </summary>
- </member>
- <member name="P:Aspose.Words.FootnoteOptions.NumberStyle">
- <summary>
- Specifies the number format for automatically numbered footnotes.
- </summary>
- <remarks>
- <para>Not all number styles are applicable for this property. For the list of applicable
- number styles see the Insert Footnote or Endnote dialog box in Microsoft Word. If you select
- a number style that is not applicable, Microsoft Word will revert to a default value.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.FootnoteOptions.StartNumber">
- <summary>
- Specifies the starting number or character for the first automatically numbered footnotes.
- </summary>
- <remarks>
- <para>This property has effect only when <see cref="P:Aspose.Words.FootnoteOptions.RestartRule" /> is set to
- <see cref="F:Aspose.Words.FootnoteNumberingRule.Continuous" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.FootnoteOptions.RestartRule">
- <summary>
- Determines when automatic numbering restarts.
- </summary>
- </member>
- <member name="P:Aspose.Words.FootnoteOptions.Columns">
- <summary>
- Specifies the number of columns with which the footnotes area is formatted.
- </summary>
- <remarks>
- If this property has the value of 0, the footnotes area is formatted with a number of columns based on
- the number of columns on the displayed page. The default value is 0.
- </remarks>
- </member>
- <member name="T:Aspose.Words.ProtectionType">
- <summary>
- Protection type for a document.
- </summary>
- <dev>Keep in the Aspose.Words namespace (not in Aspose.Words.Settings) because many clients are using
- this enum and it will be a big and unnecessary breaking change.</dev>
- </member>
- <member name="F:Aspose.Words.ProtectionType.AllowOnlyComments">
- <summary>
- User can only modify comments in the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.ProtectionType.AllowOnlyFormFields">
- <summary>
- User can only enter data in the form fields in the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.ProtectionType.AllowOnlyRevisions">
- <summary>
- User can only add revision marks to the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.ProtectionType.ReadOnly">
- <summary>
- No changes are allowed to the document. Available since Microsoft Word 2003.
- </summary>
- </member>
- <member name="F:Aspose.Words.ProtectionType.NoProtection">
- <summary>
- The document is not protected.
- </summary>
- </member>
- <member name="T:Aspose.Words.SaveFormat">
- <summary>
- Indicates the format in which the document is saved.
- </summary>
- <seealso cref="M:Aspose.Words.Document.Save(System.IO.Stream,Aspose.Words.SaveFormat)" />
- <seealso cref="T:Aspose.Words.Saving.SaveOptions" />
- <dev>
- We should only use values 0..255 here because these values are used as bit flags in the UnifiedScenario enum.
- </dev>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Unknown">
- <summary>
- Default, invalid value for file format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Doc">
- <summary>
- Saves the document in the Microsoft Word 97 - 2007 Document format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Dot">
- <summary>
- Saves the document in the Microsoft Word 97 - 2007 Template format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Docx">
- <summary>
- Saves the document as an Office Open XML WordprocessingML Document (macro-free).
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Docm">
- <summary>
- Saves the document as an Office Open XML WordprocessingML Macro-Enabled Document.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Dotx">
- <summary>
- Saves the document as an Office Open XML WordprocessingML Template (macro-free).
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Dotm">
- <summary>
- Saves the document as an Office Open XML WordprocessingML Macro-Enabled Template.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.FlatOpc">
- <summary>
- Saves the document as an Office Open XML WordprocessingML stored in a flat XML file instead of a ZIP package.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.FlatOpcMacroEnabled">
- <summary>
- Saves the document as an Office Open XML WordprocessingML Macro-Enabled Document stored in a flat XML file instead of a ZIP package.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.FlatOpcTemplate">
- <summary>
- Saves the document as an Office Open XML WordprocessingML Template (macro-free) stored in a flat XML file instead of a ZIP package.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.FlatOpcTemplateMacroEnabled">
- <summary>
- Saves the document as an Office Open XML WordprocessingML Macro-Enabled Template stored in a flat XML file instead of a ZIP package.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Rtf">
- <summary>
- Saves the document in the RTF format.
- All characters above 7-bits are escaped as hexadecimal or Unicode characters.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.WordML">
- <summary>
- Saves the document in the Microsoft Word 2003 WordprocessingML format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Pdf">
- <summary>
- Saves the document as PDF (Adobe Portable Document) format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Xps">
- <summary>
- Saves the document in the XPS (XML Paper Specification) format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.XamlFixed">
- <summary>
- Saves the document in the Extensible Application Markup Language (XAML) format as a fixed document.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Svg">
- <summary>
- Saves the document in the Svg (Scalable Vector Graphics) format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.HtmlFixed">
- <summary>
- Saves the document in the HTML format using absolutely positioned elements
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.OpenXps">
- <summary>
- Saves the document in the OpenXPS (Ecma-388) format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Ps">
- <summary>
- Saves the document in the PS (PostScript) format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Pcl">
- <summary>
- Saves the document in the PCL (Printer Control Language) format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Html">
- <summary>
- Saves the document in the HTML format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Mhtml">
- <summary>
- Saves the document in the MHTML (Web archive) format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Epub">
- <summary>
- Saves the document in the IDPF EPUB format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Odt">
- <summary>
- Saves the document as an ODF Text Document.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Ott">
- <summary>
- Saves the document as an ODF Text Document Template.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Text">
- <summary>
- Saves the document in the plain text format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.XamlFlow">
- <summary>
- <b>Beta.</b> Saves the document in the Extensible Application Markup Language (XAML) format as a flow document.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.XamlFlowPack">
- <summary>
- <b>Beta.</b> Saves the document in the Extensible Application Markup Language (XAML) package format as a flow document.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Markdown">
- <summary>
- Saves the document in the Markdown format.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Tiff">
- <summary>
- Renders a page or pages of the document and saves them into a single or multipage TIFF file.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Png">
- <summary>
- Renders a page of the document and saves it as a PNG file.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Bmp">
- <summary>
- Renders a page of the document and saves it as a BMP file.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Emf">
- <summary>
- Renders a page of the document and saves it as a vector EMF (Enhanced Meta File) file.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Jpeg">
- <summary>
- Renders a page of the document and saves it as a JPEG file.
- </summary>
- </member>
- <member name="F:Aspose.Words.SaveFormat.Gif">
- <summary>
- Renders a page of the document and saves it as a GIF file.
- </summary>
- </member>
- <member name="T:Aspose.Words.ContentDisposition">
- <summary>
- Enumerates different ways of presenting the document at the client browser.
- </summary>
- <remarks>
- <para>Note that the actual behavior on the client browser might be affected by security configuration of the browser.</para>
- </remarks>
- </member>
- <member name="F:Aspose.Words.ContentDisposition.Attachment">
- <summary>
- Send the document to the browser and present an option to save the document to disk or open in the application
- associated with the document's extension.
- </summary>
- </member>
- <member name="F:Aspose.Words.ContentDisposition.Inline">
- <summary>
- Send the document to the browser and presents an option to save the document to disk or open inside the browser.
- </summary>
- </member>
- <member name="T:Aspose.Words.UnsupportedFileFormatException">
- <summary>
- Thrown during document load, when the document format is not recognized or not supported by Aspose.Words.
- </summary>
- </member>
- <member name="T:Aspose.Words.VariableCollection">
- <summary>
- A collection of document variables.
- </summary>
- <remarks>
- <p>Variable names and values are strings.</p>
- <p>Variable names are case-insensitive.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.VariableCollection.GetEnumerator">
- <summary>
- Returns an enumerator object that can be used to iterate over all variable in the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.VariableCollection.Add(System.String,System.String)">
- <summary>
- Adds a document variable to the collection.
- </summary>
- <param name="name">The case-insensitive name of the variable to add.</param>
- <param name="value">The value of the variable. The value cannot be null, if value is null empty string will be used instead.</param>
- </member>
- <member name="M:Aspose.Words.VariableCollection.Contains(System.String)">
- <summary>
- Determines whether the collection contains a document variable with the given name.
- </summary>
- <param name="name">Case-insensitive name of the document variable to locate.</param>
- <returns>True if item is found in the collection; otherwise, false.</returns>
- </member>
- <member name="M:Aspose.Words.VariableCollection.IndexOfKey(System.String)">
- <summary>
- Returns the zero-based index of the specified document variable in the collection.
- </summary>
- <param name="name">The case-insensitive name of the variable.</param>
- <returns>The zero based index. Negative value if not found.</returns>
- </member>
- <member name="M:Aspose.Words.VariableCollection.Remove(System.String)">
- <summary>
- Removes a document variable with the specified name from the collection.
- </summary>
- <param name="name">The case-insensitive name of the variable.</param>
- </member>
- <member name="M:Aspose.Words.VariableCollection.RemoveAt(System.Int32)">
- <summary>
- Removes a document variable at the specified index.
- </summary>
- <param name="index">The zero based index.</param>
- </member>
- <member name="M:Aspose.Words.VariableCollection.Clear">
- <summary>
- Removes all elements from the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.VariableCollection.Count">
- <summary>
- Gets the number of elements contained in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.VariableCollection.Item(System.String)">
- <overloads>Provides access to the collection items.</overloads>
- <summary>
- Gets or a sets a document variable by the case-insensitive name.
- null values are not allowed as a right hand side of the assignment and will be replaced by empty string.
- </summary>
- </member>
- <member name="P:Aspose.Words.VariableCollection.Item(System.Int32)">
- <summary>
- Gets or sets a document variable at the specified index.
- null values are not allowed as a right hand side of the assignment and will be replaced by empty string.
- </summary>
- <param name="index">Zero-based index of the document variable.</param>
- </member>
- <member name="T:Aspose.Words.VisitorAction">
- <summary>
- Allows the visitor to control the enumeration of nodes.
- </summary>
- </member>
- <member name="F:Aspose.Words.VisitorAction.Continue">
- <summary>
- The visitor requests the enumeration to continue.
- </summary>
- </member>
- <member name="F:Aspose.Words.VisitorAction.SkipThisNode">
- <summary>
- The visitor requests to skip the current node and continue enumeration.
- </summary>
- </member>
- <member name="F:Aspose.Words.VisitorAction.Stop">
- <summary>
- The visitor requests the enumeration of nodes to stop.
- </summary>
- </member>
- <member name="T:Aspose.Words.DigitalSignature">
- <summary>
- Represents a digital signature on a document and the result of its verification.
- </summary>
- </member>
- <member name="M:Aspose.Words.DigitalSignature.ToString">
- <summary>
- Returns a user-friendly string that displays the value of this object.
- </summary>
- </member>
- <member name="P:Aspose.Words.DigitalSignature.SignatureType">
- <summary>
- Gets the type of the digital signature.
- </summary>
- </member>
- <member name="P:Aspose.Words.DigitalSignature.SignTime">
- <summary>
- Gets the time the document was signed.
- </summary>
- </member>
- <member name="P:Aspose.Words.DigitalSignature.Comments">
- <summary>
- Gets the signing purpose comment.
- </summary>
- </member>
- <member name="P:Aspose.Words.DigitalSignature.SubjectName">
- <summary>
- Returns the subject distinguished name of the certificate that was used to sign the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.DigitalSignature.IssuerName">
- <summary>
- Returns the subject distinguished name of the certificate isuuer.
- </summary>
- </member>
- <member name="P:Aspose.Words.DigitalSignature.IsValid">
- <summary>
- Returns true if this digital signature is valid and the document has not been tampered with.
- </summary>
- </member>
- <member name="P:Aspose.Words.DigitalSignature.CertificateHolder">
- <summary>
- Returns the certificate holder object that contains the certificate was used to sign the document.
- </summary>
- </member>
- <member name="T:Aspose.Words.DigitalSignatureCollection">
- <summary>
- Provides a read-only collection of digital signatures attached to a document.
- </summary>
- <remarks>
- <see cref="P:Aspose.Words.Document.DigitalSignatures" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.DigitalSignatureCollection.GetEnumerator">
- <summary>
- Returns a dictionary enumerator object that can be used to iterate over all items in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.DigitalSignatureCollection.IsValid">
- <summary>
- Returns <c>true</c> if all digital signatures in this collection are valid and the document has not been tampered with
- Also returns <c>true</c> if there are no digital signatures.
- Returns <c>false</c> if at least one digital signature is invalid.
- </summary>
- </member>
- <member name="P:Aspose.Words.DigitalSignatureCollection.Count">
- <summary>
- Gets the number of elements contained in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.DigitalSignatureCollection.Item(System.Int32)">
- <summary>
- Gets a document signature at the specified index.
- </summary>
- <param name="index">Zero-based index of the signature.</param>
- </member>
- <member name="T:Aspose.Words.DigitalSignatureType">
- <summary>
- Specifies the type of a digital signature.
- </summary>
- </member>
- <member name="F:Aspose.Words.DigitalSignatureType.Unknown">
- <summary>
- Indicates an error, unknown digital signature type.
- </summary>
- </member>
- <member name="F:Aspose.Words.DigitalSignatureType.CryptoApi">
- <summary>
- The Crypto API signature method used in Microsoft Word 97-2003 .DOC binary documents.
- </summary>
- </member>
- <member name="F:Aspose.Words.DigitalSignatureType.XmlDsig">
- <summary>
- The XmlDsig signature method used in OOXML and OpenDocument documents.
- </summary>
- </member>
- <member name="T:Aspose.Words.Footnote">
- <summary>
- Represents a container for text of a footnote or endnote.
- </summary>
- <remarks>
- <p>The <b>Footnote</b> class is used to represent both footnotes and endnotes in a Word document.</p>
- <p>
- <b>Footnote</b> is an inline-level node and can only be a child of <b>Paragraph</b>.</p>
- <p>
- <b>Footnote</b> can contain <b>Paragraph</b> and <b>Table</b> child nodes.</p>
- <seealso cref="P:Aspose.Words.Footnote.FootnoteType" />
- <seealso cref="M:Aspose.Words.DocumentBuilder.InsertFootnote(Aspose.Words.FootnoteType,System.String)" />
- <seealso cref="T:Aspose.Words.FootnoteOptions" />
- <seealso cref="T:Aspose.Words.EndnoteOptions" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Footnote.#ctor(Aspose.Words.DocumentBase,Aspose.Words.FootnoteType)">
- <summary>
- Initializes an instance of the <b>Footnote</b> class.
- </summary>
- <remarks>
- <p>When <b>Footnote</b> is created, it belongs to the specified document, but is not
- yet part of the document and <b>ParentNode</b> is null.</p>
- <p>To append <b>Footnote</b> to the document use InsertAfter or InsertBefore
- on the paragraph where you want the footnote inserted.</p>
- </remarks>
- <param name="doc">The owner document.</param>
- <param name="footnoteType">A <see cref="P:Aspose.Words.Footnote.FootnoteType" /> value
- that specifies whether this is a footnote or endnote.</param>
- </member>
- <member name="M:Aspose.Words.Footnote.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls DocumentVisitor.VisitFootnoteStart, then calls Accept for all child nodes of the footnote
- and calls DocumentVisitor.VisitFootnoteEnd at the end.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Footnote.NodeType">
- <summary>
- Returns <b>NodeType.Footnote</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Footnote.StoryType">
- <summary>
- Returns <b>StoryType.Footnotes</b> or <b>StoryType.Endnotes</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Footnote.FootnoteType">
- <summary>
- Returns a value that specifies whether this is a footnote or endnote.
- </summary>
- </member>
- <member name="P:Aspose.Words.Footnote.IsAuto">
- <summary>
- Holds a value that specifies whether this is a auto-numbered footnote or
- footnote with user defined custom reference mark.
- </summary>
- <remarks>
- <see cref="P:Aspose.Words.Footnote.ReferenceMark" /> initialized with empty string if IsAuto set to false.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Footnote.ReferenceMark">
- <summary>
- Gets/sets custom reference mark to be used for this footnote.
- Default value is <b>empty string</b> (<see cref="F:System.String.Empty" />), meaning auto-numbered footnotes are used.
- </summary>
- <remarks>
- <para>
- If this property is set to <b>empty string</b> (<see cref="F:System.String.Empty" />) or null, then <see cref="P:Aspose.Words.Footnote.IsAuto" /> property will automatically be set to true,
- if set to anything else then <see cref="P:Aspose.Words.Footnote.IsAuto" /> will be set to false.
- </para>
- <para>
- RTF-format can only store 1 symbol as custom reference mark, so upon export only the first symbol will be written others will be discard.
- </para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.FootnoteType">
- <summary>
- Specifies whether this is a footnote or an endnote.
- </summary>
- <remarks>
- <para>Both footnotes and endnotes are represented by objects by the <see cref="F:Aspose.Words.FootnoteType.Footnote" />
- class. Use <see cref="P:Aspose.Words.Footnote.FootnoteType" /> to distinguish between footnotes
- and endnotes.</para>
- <seealso cref="F:Aspose.Words.FootnoteType.Footnote" />
- </remarks>
- </member>
- <member name="F:Aspose.Words.FootnoteType.Footnote">
- <summary>
- The object is a footnote.
- </summary>
- </member>
- <member name="F:Aspose.Words.FootnoteType.Endnote">
- <summary>
- The object is an endnote.
- </summary>
- </member>
- <member name="T:Aspose.Words.NumberStyle">
- <summary>
- Specifies the number style for a list, footnotes and endnotes, page numbers.
- </summary>
- <dev>
- Should keep members of this enum in sync with <see cref="T:Aspose.Numbering.NumberStyleCore" />.
- </dev>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Arabic">
- <summary>
- Arabic numbering (1, 2, 3, ...)
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.UppercaseRoman">
- <summary>
- Upper case Roman (I, II, III, ...)
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.LowercaseRoman">
- <summary>
- Lower case Roman (i, ii, iii, ...)
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.UppercaseLetter">
- <summary>
- Upper case Letter (A, B, C, ...)
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.LowercaseLetter">
- <summary>
- Lower case letter (a, b, c, ...)
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Ordinal">
- <summary>
- Ordinal (1st, 2nd, 3rd, ...)
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Number">
- <summary>
- Numbered (One, Two, Three, ...)
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.OrdinalText">
- <summary>
- Ordinal (text) (First, Second, Third, ...)
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Hex">
- <summary>
- Hexadecimal: 8, 9, A, B, C, D, E, F, 10, 11, 12
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.ChicagoManual">
- <summary>
- Chicago Manual of Style: *, †, †
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Kanji">
- <summary>
- Ideograph-digital
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.KanjiDigit">
- <summary>
- Japanese counting
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.AiueoHalfWidth">
- <summary>
- Aiueo
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.IrohaHalfWidth">
- <summary>
- Iroha
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.ArabicFullWidth">
- <summary>
- Full-width Arabic: 1, 2, 3, 4
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.ArabicHalfWidth">
- <summary>
- Half-width Arabic: 1, 2, 3, 4
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.KanjiTraditional">
- <summary>
- Japanese legal
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.KanjiTraditional2">
- <summary>
- Japanese digital ten thousand
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.NumberInCircle">
- <summary>
- Enclosed circles
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.DecimalFullWidth">
- <summary>
- Decimal full width: 1, 2, 3, 4
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Aiueo">
- <summary>
- Aiueo full width
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Iroha">
- <summary>
- Iroha full width
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.LeadingZero">
- <summary>
- Leading Zero (01, 02,..., 09, 10, 11,..., 99, 100, 101,...)
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Bullet">
- <summary>
- Bullet (check the character code in the text)
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Ganada">
- <summary>
- Korean Ganada
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Chosung">
- <summary>
- Korea Chosung
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.GB1">
- <summary>
- Enclosed full stop
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.GB2">
- <summary>
- Enclosed parenthesis
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.GB3">
- <summary>
- Enclosed circle Chinese
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.GB4">
- <summary>
- Ideograph enclosed circle
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Zodiac1">
- <summary>
- Ideograph traditional
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Zodiac2">
- <summary>
- Ideograph Zodiac
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Zodiac3">
- <summary>
- Ideograph Zodiac traditional
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.TradChinNum1">
- <summary>
- Taiwanese counting
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.TradChinNum2">
- <summary>
- Ideograph legal traditional
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.TradChinNum3">
- <summary>
- Taiwanese counting thousand
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.TradChinNum4">
- <summary>
- Taiwanese digital
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.SimpChinNum1">
- <summary>
- Chinese counting
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.SimpChinNum2">
- <summary>
- Chinese legal simplified
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.SimpChinNum3">
- <summary>
- Chinese counting thousand
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.SimpChinNum4">
- <summary>
- Chinese (not implemented)
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.HanjaRead">
- <summary>
- Korean digital
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.HanjaReadDigit">
- <summary>
- Korean counting
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Hangul">
- <summary>
- Korea legal
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Hanja">
- <summary>
- Korea digital2
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Hebrew1">
- <summary>
- Hebrew-1
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Arabic1">
- <summary>
- Arabic alpha
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Hebrew2">
- <summary>
- Hebrew-2
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Arabic2">
- <summary>
- Arabic abjad
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.HindiLetter1">
- <summary>
- Hindi vowels
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.HindiLetter2">
- <summary>
- Hindi consonants
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.HindiArabic">
- <summary>
- Hindi numbers
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.HindiCardinalText">
- <summary>
- Hindi descriptive (cardinals)
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.ThaiLetter">
- <summary>
- Thai letters
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.ThaiArabic">
- <summary>
- Thai numbers
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.ThaiCardinalText">
- <summary>
- Thai descriptive (cardinals)
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.VietCardinalText">
- <summary>
- Vietnamese descriptive (cardinals)
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.NumberInDash">
- <summary>
- Page number format: - 1 -, - 2 -, - 3 -, - 4 -
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.LowercaseRussian">
- <summary>
- Lowercase Russian alphabet
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.UppercaseRussian">
- <summary>
- Uppercase Russian alphabet
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.None">
- <summary>
- No bullet or number.
- </summary>
- </member>
- <member name="F:Aspose.Words.NumberStyle.Custom">
- <summary>
- Custom number format. It is supported by DOCX format only.
- </summary>
- </member>
- <member name="T:Aspose.Words.ImportFormatMode">
- <summary>
- Specifies how formatting is merged when importing content from another document.
- </summary>
- <remarks>
- <p>When you copy nodes from one document to another, this option specifies how formatting
- is resolved when both documents have a style with the same name, but different formatting.</p>
- <p>The formatting is resolved as follows:</p>
- <list type="number">
- <item>Built-in styles are matched using their locale independent style identifier.
- User defined styles are matched using case-sensitive style name.</item>
- <item>If a matching style is not found in the destination document, the style
- (and all styles referenced by it) are copied into the destination document
- and the imported nodes are updated to reference the new style.</item>
- <item>If a matching style already exists in the destination document, what happens
- depends on the <c>importFormatMode</c> parameter passed to
- <see cref="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)">Document.ImportNode</see>
- as described below.</item>
- </list>
- <p>When using the <b>UseDestinationStyles</b> option, if a matching style already exists
- in the destination document, the style is not copied and the imported nodes are updated
- to reference the existing style.</p>
- <p>The drawback of using <b>UseDestinationStyles</b> is that the imported text might
- look different in the destination document comparing to the source document.
- For example, the "Heading 1" style in the source document uses Arial 16pt font and
- the "Heading 1" style in the destination document uses Times New Roman 14pt font.
- When importing text of "Heading 1" style with no other direct formatting, it will
- appear as Times New Roman 14pt font in the destination document.</p>
- <p>
- <b>KeepSourceFormatting</b> option allows to make sure the imported content looks the same
- in the destination document like it looks in the source document.
- If a matching style already exists in the destination document, the source style formatting is expanded
- into direct Node attributes and the style is changed to Normal.
- If the style does not exist in the destination document, then the source style is imported
- into the destination document and applied to the imported node.
- Note, that it is not always possible to preserve the source style even if it does not exist in the destination document.
- In this case formating of such style will be expanded into direct Node attributes in favor of preserving original Node formatting.</p>
- <p>The drawback of using <b>KeepSourceFormatting</b> is that if you perform several imports,
- you could end up with many styles in the destination document and that could make using
- consistent style formatting in Microsoft Word difficult for this document.</p>
- <p>Using <b>KeepDifferentStyles</b> option allows to reuse destination styles
- if the formatting they provide is identical to the styles in the source document.
- If the style in destination document is different from the source then it is imported.</p>
- <seealso cref="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.ImportFormatMode)" />
- </remarks>
- </member>
- <member name="F:Aspose.Words.ImportFormatMode.UseDestinationStyles">
- <summary>
- Use the destination document styles and copy new styles. This is the default option.
- </summary>
- </member>
- <member name="F:Aspose.Words.ImportFormatMode.KeepSourceFormatting">
- <summary>
- Copy all required styles to the destination document, generate unique style names if needed.
- </summary>
- </member>
- <member name="F:Aspose.Words.ImportFormatMode.KeepDifferentStyles">
- <summary>
- Only copy styles that are different from those in the source document.
- </summary>
- </member>
- <member name="T:Aspose.Words.NodeImporter">
- <summary>
- Allows to efficiently perform repeated import of nodes from one document to another.
- </summary>
- <remarks>
- <p>Aspose.Words provides functionality for easy copying and moving fragments
- between Microsoft Word documents. This is known as "importing nodes".
- Before you can insert a fragment from one document into another, you need to "import" it.
- Importing creates a deep clone of the original node, ready to be inserted into the
- destination document.</p>
- <p>The simplest way to import a node is to use the <see cref="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean)" /> method
- provided by the <see cref="T:Aspose.Words.DocumentBase" /> object.</p>
- <p>However, when you need to import nodes from one document to another multiple times,
- it is better to use the <see cref="T:Aspose.Words.NodeImporter" /> class. The <see cref="T:Aspose.Words.NodeImporter" />
- class allows to minimize the number of styles and lists created in the destination document.</p>
- <p>Copying or moving fragments from one Microsoft Word document to another presents a number
- of technical challenges for Aspose.Words. In a Word document, styles and list formatting
- are stored centrally, separately from the text of the document. The paragraphs
- and runs of text merely reference the styles by internal unique identifiers.</p>
- <p>The challenges arise from the fact that styles and lists are different in different documents.
- For example, to copy a paragraph formatted with the Heading 1 style from one document to another,
- a number of things must be taken into account: decide whether to copy the Heading 1 style from
- the source document to the destination document, clone the paragraph, update the cloned
- paragraph so it refers to the correct Heading 1 style in the destination document.
- If the style had to be copied, all the styles that it references (based on style
- and next paragraph style) should be analyzed and possibly copied too and so on.
- Similar issues exist when copying bulleted or numbered paragraphs because Microsoft Word
- stores list definitions separately from text.</p>
- <p>The <see cref="T:Aspose.Words.NodeImporter" /> class is like a context, that holds the "translation tables"
- during the import. It correctly translates between styles and lists in the source and
- destination documents.</p>
- <seealso cref="T:Aspose.Words.Document" />
- <seealso cref="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean)" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.NodeImporter.#ctor(Aspose.Words.DocumentBase,Aspose.Words.DocumentBase,Aspose.Words.ImportFormatMode)">
- <summary>
- Initializes a new instance of the <see cref="T:Aspose.Words.NodeImporter" /> class.
- </summary>
- <param name="srcDoc">The source document.</param>
- <param name="dstDoc">The destination document that will be the owner of imported nodes.</param>
- <param name="importFormatMode">Specifies how to merge style formatting that clashes.</param>
- </member>
- <member name="M:Aspose.Words.NodeImporter.#ctor(Aspose.Words.DocumentBase,Aspose.Words.DocumentBase,Aspose.Words.ImportFormatMode,Aspose.Words.ImportFormatOptions)">
- <summary>
- Initializes a new instance of the <see cref="T:Aspose.Words.NodeImporter" /> class.
- </summary>
- <param name="srcDoc">The source document.</param>
- <param name="dstDoc">The destination document that will be the owner of imported nodes.</param>
- <param name="importFormatMode">Specifies how to merge style formatting that clashes.</param>
- <param name="importFormatOptions">Specifies various options to format imported node.</param>
- </member>
- <member name="M:Aspose.Words.NodeImporter.ImportNode(Aspose.Words.Node,System.Boolean)">
- <summary>
- <p>Imports a node from one document into another.</p>
- </summary>
- <remarks>
- <p>Importing a node creates a copy of the source node belonging to the importing document.
- The returned node has no parent. The source node is not altered or removed from the original document.</p>
- <p>Before a node from another document can be inserted into this document, it must be imported.
- During import, document-specific properties such as references to styles and lists are translated
- from the original to the importing document. After the node was imported, it can be inserted
- into the appropriate place in the document using <see cref="M:Aspose.Words.CompositeNode.InsertBefore(Aspose.Words.Node,Aspose.Words.Node)" /> or
- <see cref="M:Aspose.Words.CompositeNode.InsertAfter(Aspose.Words.Node,Aspose.Words.Node)" />.</p>
- <p>If the source node already belongs to the destination document, then simply a deep clone
- of the source node is created.</p>
- </remarks>
- <param name="srcNode">The node to import.</param>
- <param name="isImportChildren">True to import all child nodes recursively; otherwise, false.</param>
- <returns>The cloned, imported node. The node belongs to the destination document, but has no parent.</returns>
- </member>
- <member name="M:Aspose.Words.NodeImporter.ImportNode(Aspose.Words.Node,System.Boolean,Aspose.Words.INodeCloningListener)">
- <summary>
- <p>Imports a node from one document into another.</p>
- </summary>
- <remarks>
- <p>Importing a node creates a copy of the source node belonging to the importing document.
- The returned node has no parent. The source node is not altered or removed from the original document.</p>
- <p>Before a node from another document can be inserted into this document, it must be imported.
- During import, document-specific properties such as references to styles and lists are translated
- from the original to the importing document. After the node was imported, it can be inserted
- into the appropriate place in the document using <see cref="M:Aspose.Words.CompositeNode.InsertBefore(Aspose.Words.Node,Aspose.Words.Node)" /> or
- <see cref="M:Aspose.Words.CompositeNode.InsertAfter(Aspose.Words.Node,Aspose.Words.Node)" />.</p>
- <p>If the source node already belongs to the destination document, then simply a deep clone
- of the source node is created.</p>
- </remarks>
- <param name="srcNode">The node to import.</param>
- <param name="isImportChildren">True to import all child nodes recursively; otherwise, false.</param>
- <param name="nodeCloningListener">The listener to the node cloning events.</param>
- <returns>The cloned, imported node. The node belongs to the destination document, but has no parent.</returns>
- </member>
- <member name="T:Aspose.Words.Body">
- <summary>
- Represents a container for the main text of a section.
- </summary>
- <remarks>
- <p>
- <b>Body</b> can contain <b>Paragraph</b> and <b>Table</b> child nodes.</p>
- <p>
- <b>Body</b> is a section-level node and can only be a child of <b>Section</b>.
- There can only be one <b>Body</b> in a <b>Section</b>.</p>
- <p>A minimal valid <b>Body</b> needs to contain at least one <b>Paragraph</b>.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Body.#ctor(Aspose.Words.DocumentBase)">
- <summary>
- Initializes a new instance of the <b>Body</b> class.
- </summary>
- <remarks>
- <p>When <b>Body</b> is created, it belongs to the specified document, but is not
- yet part of the document and <b>ParentNode</b> is null.</p>
- <p>To append <b>Body</b> to a <b>Section</b> use Section.InsertAfter or Section.InsertBefore.</p>
- </remarks>
- <param name="doc">The owner document.</param>
- </member>
- <member name="M:Aspose.Words.Body.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls DocumentVisitor.VisitBodyStart, then calls Accept for all child nodes of the section
- and calls DocumentVisitor.VisitBodyEnd at the end.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Body.EnsureMinimum">
- <summary>
- If the last child is not a paragraph, creates and appends one empty paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.Body.NodeType">
- <summary>
- Returns <b>NodeType.Body</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Body.ParentSection">
- <summary>
- Gets the parent section of this story.
- </summary>
- <remarks>
- <p>
- <b>ParentSection</b> is equivalent to <c>(Section)ParentNode</c>.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.SectionLayoutMode">
- <summary>
- Specifies the layout mode for a section allowing to define the document grid behavior.
- </summary>
- </member>
- <member name="F:Aspose.Words.SectionLayoutMode.Default">
- <summary>
- Specifies that no document grid shall be applied to the contents of the corresponding section in the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.SectionLayoutMode.Grid">
- <summary>
- Specifies that the corresponding section shall have both the additional line pitch and character pitch
- added to each line and character within it in order to maintain a specific number
- of lines per page and characters per line.
- Characters will not be automatically aligned with gridlines on typing.
- </summary>
- </member>
- <member name="F:Aspose.Words.SectionLayoutMode.LineGrid">
- <summary>
- Specifies that the corresponding section shall have additional line pitch added to each line within it
- in order to maintain the specified number of lines per page.
- </summary>
- </member>
- <member name="F:Aspose.Words.SectionLayoutMode.SnapToChars">
- <summary>
- Specifies that the corresponding section shall have both the additional line pitch and character pitch
- added to each line and character within it in order to maintain a specific number
- of lines per page and characters per line.
- Characters will be automatically aligned with gridlines on typing.
- </summary>
- </member>
- <member name="T:Aspose.Words.HeaderFooter">
- <summary>
- Represents a container for the header or footer text of a section.
- </summary>
- <remarks>
- <p>
- <b>HeaderFooter</b> can contain <b>Paragraph</b> and <b>Table</b> child nodes.</p>
- <p>
- <b>HeaderFooter</b> is a section-level node and can only be a child of <b>Section</b>.
- There can only be one <b>HeaderFooter</b> or each <see cref="P:Aspose.Words.HeaderFooter.HeaderFooterType" /> in a <b>Section</b>.</p>
- <p>If <b>Section</b> does not have a <b>HeaderFooter</b> of a specific type or
- the <b>HeaderFooter</b> has no child nodes, this header/footer is considered linked to
- the header/footer of the same type of the previous section in Microsoft Word.</p>
- <p>When <b>HeaderFooter</b> contains at least one <b>Paragraph</b>, it is no longer
- considered linked to previous in Microsoft Word.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.HeaderFooter.#ctor(Aspose.Words.DocumentBase,Aspose.Words.HeaderFooterType)">
- <summary>
- Creates a new header or footer of the specified type.
- </summary>
- <remarks>
- <p>When <b>HeaderFooter</b> is created, it belongs to the specified document, but is not
- yet part of the document and <b>ParentNode</b> is null.</p>
- <p>To append <b>HeaderFooter</b> to a <b>Section</b> use Section.InsertAfter, Section.InsertBefore,
- HeadersFooters.Add or HeadersFooters.Insert.</p>
- </remarks>
- <param name="doc">The owner document.</param>
- <param name="headerFooterType">A <see cref="P:Aspose.Words.HeaderFooter.HeaderFooterType" /> value
- that specifies the type of the header or footer.</param>
- </member>
- <member name="M:Aspose.Words.HeaderFooter.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls DocumentVisitor.VisitHeaderFooterStart, then calls Accept for all child nodes of the section
- and calls DocumentVisitor.VisitHeaderFooterEnd at the end.
- </remarks>
- </member>
- <member name="P:Aspose.Words.HeaderFooter.NodeType">
- <summary>
- Returns <b>NodeType.HeaderFooter</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.HeaderFooter.ParentSection">
- <summary>
- Gets the parent section of this story.
- </summary>
- <remarks>
- <p>
- <b>ParentSection</b> is equivalent to <c>(Section)ParentNode</c>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.HeaderFooter.HeaderFooterType">
- <summary>
- Gets the type of this header/footer.
- </summary>
- </member>
- <member name="P:Aspose.Words.HeaderFooter.IsHeader">
- <summary>
- True if this <b>HeaderFooter</b> object is a header.
- </summary>
- </member>
- <member name="P:Aspose.Words.HeaderFooter.IsLinkedToPrevious">
- <summary>
- True if this header or footer is linked to the corresponding header or footer
- in the previous section.
- </summary>
- <remarks>
- <p>Default is true.</p>
- <p>Note, when your link a header or footer, its contents is cleared.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.HeaderFooterType">
- <summary>
- Identifies the type of header or footer found in a Word file.
- </summary>
- <rev>
- This is a per section header/footer.
- Do not renumber as the value of the enum used as an index into plcfhdd.
- </rev>
- </member>
- <member name="F:Aspose.Words.HeaderFooterType.HeaderEven">
- <summary>
- Header for even numbered pages.
- </summary>
- </member>
- <member name="F:Aspose.Words.HeaderFooterType.HeaderPrimary">
- <summary>
- Primary header, also used for odd numbered pages.
- </summary>
- </member>
- <member name="F:Aspose.Words.HeaderFooterType.FooterEven">
- <summary>
- Footer for even numbered pages.
- </summary>
- </member>
- <member name="F:Aspose.Words.HeaderFooterType.FooterPrimary">
- <summary>
- Primary footer, also used for odd numbered pages.
- </summary>
- </member>
- <member name="F:Aspose.Words.HeaderFooterType.HeaderFirst">
- <summary>
- Header for the first page of the section.
- </summary>
- </member>
- <member name="F:Aspose.Words.HeaderFooterType.FooterFirst">
- <summary>
- Footer for the first page of the section.
- </summary>
- </member>
- <member name="T:Aspose.Words.HeaderFooterCollection">
- <summary>
- Provides typed access to <see cref="T:Aspose.Words.HeaderFooter" /> nodes of a <b>Section</b>.
- </summary>
- <remarks>
- <p>There can be maximum of one <b>HeaderFooter</b></p> of each <see cref="T:Aspose.Words.HeaderFooterType" /> per
- <b>Section</b>.
- <p><b>HeaderFooter</b> objects can occur in any order in the collection.</p></remarks>
- </member>
- <member name="M:Aspose.Words.HeaderFooterCollection.LinkToPrevious(System.Boolean)">
- <summary>
- Links or unlinks all headers and footers to the corresponding
- headers and footers in the previous section.
- </summary>
- <remarks>
- <p>If any of the headers or footers do not exist, creates them automatically.</p>
- </remarks>
- <param name="isLinkToPrevious">True to link the headers and footers to the previous section;
- false to unlink them.</param>
- </member>
- <member name="M:Aspose.Words.HeaderFooterCollection.LinkToPrevious(Aspose.Words.HeaderFooterType,System.Boolean)">
- <summary>
- Links or unlinks the specified header or footer to the corresponding
- header or footer in the previous section.
- </summary>
- <remarks>
- <p>If the header or footer of the specified type does not exist, creates it automatically.</p>
- </remarks>
- <param name="headerFooterType">A <see cref="T:Aspose.Words.HeaderFooterType" /> value
- that specifies the header or footer to link/unlink.</param>
- <param name="isLinkToPrevious">True to link the header or footer to the previous section;
- false to unlink.</param>
- </member>
- <member name="M:Aspose.Words.HeaderFooterCollection.ToArray">
- <summary>
- Copies all <c>HeaderFoorter</c>s from the collection to a new array of <c>HeaderFoorter</c>s.
- </summary>
- <returns>An array of <c>HeaderFoorter</c>s.</returns>
- </member>
- <member name="P:Aspose.Words.HeaderFooterCollection.Item(System.Int32)">
- <summary>
- Retrieves a <b>HeaderFooter</b> at the given index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the collection.</param>
- </member>
- <member name="P:Aspose.Words.HeaderFooterCollection.Item(Aspose.Words.HeaderFooterType)">
- <summary>
- Retrieves a <b>HeaderFooter</b> of the specified type.
- </summary>
- <remarks>
- Returns null if the header/footer of the specified type is not found.
- </remarks>
- <param name="headerFooterType">A <see cref="T:Aspose.Words.HeaderFooterType" /> value
- that specifies the type of the header/footer to retrieve.</param>
- </member>
- <member name="T:Aspose.Words.LineNumberRestartMode">
- <summary>
- Determines when automatic line numbering restarts.
- </summary>
- <seealso cref="T:Aspose.Words.PageSetup" />
- <seealso cref="P:Aspose.Words.PageSetup.LineNumberRestartMode" />
- </member>
- <member name="F:Aspose.Words.LineNumberRestartMode.RestartPage">
- <summary>
- Line numbering restarts at the start of every page.
- </summary>
- </member>
- <member name="F:Aspose.Words.LineNumberRestartMode.RestartSection">
- <summary>
- Line numbering restarts at the section start.
- </summary>
- </member>
- <member name="F:Aspose.Words.LineNumberRestartMode.Continuous">
- <summary>
- Line numbering continuous from the previous section.
- </summary>
- </member>
- <member name="T:Aspose.Words.Orientation">
- <summary>
- Specifies page orientation.
- </summary>
- </member>
- <member name="F:Aspose.Words.Orientation.Portrait">
- <summary>
- Portrait page orientation (narrow and tall).
- </summary>
- </member>
- <member name="F:Aspose.Words.Orientation.Landscape">
- <summary>
- Landscape page orientation (wide and short).
- </summary>
- </member>
- <member name="T:Aspose.Words.PageBorderAppliesTo">
- <summary>
- Specifies which pages the page border is printed on.
- </summary>
- <seealso cref="T:Aspose.Words.PageSetup" />
- <seealso cref="P:Aspose.Words.PageSetup.BorderAppliesTo" />
- </member>
- <member name="F:Aspose.Words.PageBorderAppliesTo.AllPages">
- <summary>
- Page border is shown on all pages of the section.
- </summary>
- </member>
- <member name="F:Aspose.Words.PageBorderAppliesTo.FirstPage">
- <summary>
- Page border is shown on the first page of the section only.
- </summary>
- </member>
- <member name="F:Aspose.Words.PageBorderAppliesTo.OtherPages">
- <summary>
- Page border is shown on all pages except the first page of the section.
- </summary>
- </member>
- <member name="T:Aspose.Words.PageBorderDistanceFrom">
- <summary>
- Specifies the positioning of the page border relative to the page margin.
- </summary>
- <seealso cref="T:Aspose.Words.PageSetup" />
- <seealso cref="P:Aspose.Words.PageSetup.BorderDistanceFrom" />
- </member>
- <member name="F:Aspose.Words.PageBorderDistanceFrom.Text">
- <summary>
- Border position is measured from the page margin.
- </summary>
- </member>
- <member name="F:Aspose.Words.PageBorderDistanceFrom.PageEdge">
- <summary>
- Border position is measured from the page edge.
- </summary>
- </member>
- <member name="T:Aspose.Words.PageSetup">
- <summary>
- Represents the page setup properties of a section.
- </summary>
- <remarks>
- <p>
- <b>PageSetup</b> object contains all the page setup attributes of a section
- (left margin, bottom margin, paper size, and so on) as properties.</p>
- </remarks>
- <dev>
- This is a presentation object only, does not store any model data.
- </dev>
- </member>
- <member name="M:Aspose.Words.PageSetup.ClearFormatting">
- <summary>
- Resets page setup to default paper size, margins and orientation.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.OddAndEvenPagesHeaderFooter">
- <summary>
- <b>True</b> if the document has different headers and footers for odd-numbered and even-numbered pages.
- </summary>
- <remarks>
- Note, changing this property affects all sections in the document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.PageSetup.DifferentFirstPageHeaderFooter">
- <summary>
- <b>True</b> if a different header or footer is used on the first page.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.MultiplePages">
- <summary>
- For multiple page documents, gets or sets how a document is printed or rendered so that it can be bound as a booklet.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.SheetsPerBooklet">
- <summary>
- Returns or sets the number of pages to be included in each booklet.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.SectionStart">
- <summary>
- Returns or sets the type of section break for the specified object.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.SuppressEndnotes">
- <summary>
- <b>True</b> if endnotes are printed at the end of the next section that doesn't suppress endnotes.
- Suppressed endnotes are printed before the endnotes in that section.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.VerticalAlignment">
- <summary>
- Returns or sets the vertical alignment of text on each page in a document or section.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.Bidi">
- <summary>
- Specifies that this section contains bidirectional (complex scripts) text.
- </summary>
- <remarks>
- <p>When true, the columns in this section are laid out from right to left.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.PageSetup.LayoutMode">
- <summary>
- Gets or sets the layout mode of this section.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.CharactersPerLine">
- <summary>
- Gets or sets the number of characters per line in the document grid.
- </summary>
- <remarks>
- <para>Minimum value of the property is 1. Maximum value depends on page width and font size of the Normal
- style. Minimum character pitch is 90 percent of the font size. For example, maximum number of characters
- per line of a Letter page with one-inch margins is 43.</para>
- <para>By default, the property has a value, on which character pitch equals to font size of the Normal
- style.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.PageSetup.LinesPerPage">
- <summary>
- Gets or sets the number of lines per page in the document grid.
- </summary>
- <remarks>
- <para>Minimum value of the property is 1. Maximum value depends on page height and font size of the Normal
- style. Minimum line pitch is 136 percent of the font size. For example, maximum number of lines per page of
- a Letter page with one-inch margins is 39.</para>
- <para>By default, the property has a value, on which line pitch is in 1.5 times greater than font size of
- the Normal style.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.PageSetup.PageWidth">
- <summary>
- Returns or sets the width of the page in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.PageHeight">
- <summary>
- Returns or sets the height of the page in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.PaperSize">
- <summary>
- Returns or sets the paper size.
- </summary>
- <remarks>
- <para>Setting this property updates <see cref="P:Aspose.Words.PageSetup.PageWidth" /> and <see cref="P:Aspose.Words.PageSetup.PageHeight" /> values.
- Setting this value to <see cref="F:Aspose.Words.PaperSize.Custom" /> does not change existing values.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.PageSetup.Orientation">
- <summary>
- Returns or sets the orientation of the page.
- </summary>
- <remarks>
- <p>Changing <b>Orientation</b> swaps <see cref="P:Aspose.Words.PageSetup.PageWidth" /> and <see cref="P:Aspose.Words.PageSetup.PageHeight" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.PageSetup.LeftMargin">
- <summary>
- Returns or sets the distance (in points) between the left edge of the page and the left boundary of the body text.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.RightMargin">
- <summary>
- Returns or sets the distance (in points) between the right edge of the page and the right boundary of the body text.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.TopMargin">
- <summary>
- Returns or sets the distance (in points) between the top edge of the page and the top boundary of the body text.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.BottomMargin">
- <summary>
- Returns or sets the distance (in points) between the bottom edge of the page and the bottom boundary of the body text.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.HeaderDistance">
- <summary>
- Returns or sets the distance (in points) between the header and the top of the page.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.FooterDistance">
- <summary>
- Returns or sets the distance (in points) between the footer and the bottom of the page.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.Gutter">
- <summary>
- Gets or sets the amount of extra space added to the margin for document binding.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.FirstPageTray">
- <summary>
- Gets or sets the paper tray (bin) to use for the first page of a section.
- The value is implementation (printer) specific.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.OtherPagesTray">
- <summary>
- Gets or sets the paper tray (bin) to be used for all but the first page of a section.
- The value is implementation (printer) specific.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.PageNumberStyle">
- <summary>
- Gets or sets the page number format.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.RestartPageNumbering">
- <summary>
- <b>True</b> if page numbering restarts at the beginning of the section.
- </summary>
- <remarks>
- If set to <b>false</b>, the <b>RestartPageNumbering</b> property will override the
- <see cref="P:Aspose.Words.PageSetup.PageStartingNumber" /> property so that page numbering can continue from the previous section.
- </remarks>
- </member>
- <member name="P:Aspose.Words.PageSetup.PageStartingNumber">
- <summary>
- Gets or sets the starting page number of the section.
- </summary>
- <remarks>
- The <see cref="P:Aspose.Words.PageSetup.RestartPageNumbering" /> property, if set to <b>false</b>, will override the
- <b>PageStartingNumber</b> property so that page numbering can continue from the previous section.
- </remarks>
- </member>
- <member name="P:Aspose.Words.PageSetup.LineNumberRestartMode">
- <summary>
- Gets or sets the way line numbering runs that is, whether it starts over at the beginning of a new
- page or section or runs continuously.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.LineNumberCountBy">
- <summary>
- Returns or sets the numeric increment for line numbers.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.LineNumberDistanceFromText">
- <summary>
- Gets or sets distance between the right edge of line numbers and the left edge of the document.
- </summary>
- <remarks>
- Set this property to zero for automatic distance between the line numbers and text of the document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.PageSetup.LineStartingNumber">
- <summary>
- Gets or sets the starting line number.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.TextColumns">
- <summary>
- Returns a collection that represents the set of text columns.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.RtlGutter">
- <summary>
- Gets or sets whether Microsoft Word uses gutters for the section based on a right-to-left language or a left-to-right language.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.BorderAlwaysInFront">
- <summary>
- Specifies where the page border is positioned relative to intersecting texts and objects.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.BorderDistanceFrom">
- <summary>
- Gets or sets a value that indicates whether the specified page border is measured from the edge of the page or from the text it surrounds.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.BorderAppliesTo">
- <summary>
- Specifies which pages the page border is printed on.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.BorderSurroundsHeader">
- <summary>
- Specifies whether the page border includes or excludes the header.
- </summary>
- <remarks>
- Note, changing this property affects all sections in the document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.PageSetup.BorderSurroundsFooter">
- <summary>
- Specifies whether the page border includes or excludes the footer.
- </summary>
- <remarks>
- Note, changing this property affects all sections in the document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.PageSetup.Borders">
- <summary>
- Gets a collection of the page borders.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.FootnoteOptions">
- <summary>
- Provides options that control numbering and positioning of footnotes in this section.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.EndnoteOptions">
- <summary>
- Provides options that control numbering and positioning of endnotes in this section.
- </summary>
- </member>
- <member name="P:Aspose.Words.PageSetup.TextOrientation">
- <summary>
- Allows to specify <see cref="P:Aspose.Words.PageSetup.TextOrientation" /> for the whole page.
- Default value is <see cref="F:Aspose.Words.TextOrientation.Horizontal" /></summary>
- <remarks>This property is only supported for MS Word native formats DOCX, WML, RTF and DOC.</remarks>
- </member>
- <member name="T:Aspose.Words.PageVerticalAlignment">
- <summary>
- Specifies vertical justification of text on each page.
- </summary>
- <seealso cref="T:Aspose.Words.PageSetup" />
- <seealso cref="P:Aspose.Words.PageSetup.VerticalAlignment" />
- </member>
- <member name="F:Aspose.Words.PageVerticalAlignment.Bottom">
- <summary>
- Text is aligned at the bottom of the page.
- </summary>
- </member>
- <member name="F:Aspose.Words.PageVerticalAlignment.Center">
- <summary>
- Text is aligned in the middle of the page.
- </summary>
- </member>
- <member name="F:Aspose.Words.PageVerticalAlignment.Justify">
- <summary>
- Text is spread to fill the page.
- </summary>
- </member>
- <member name="F:Aspose.Words.PageVerticalAlignment.Top">
- <summary>
- Text is aligned at the top of the page.
- </summary>
- </member>
- <member name="T:Aspose.Words.PaperSize">
- <summary>
- Specifies paper size.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.A3">
- <summary>
- 297 x 420 mm.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.A4">
- <summary>
- 210 x 297 mm.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.A5">
- <summary>
- 148 x 210 mm.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.B4">
- <summary>
- 250 x 353 mm.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.B5">
- <summary>
- 176 x 250 mm.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.Executive">
- <summary>
- 7.25 x 10.5 inches.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.Folio">
- <summary>
- 8.5 x 13 inches.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.Ledger">
- <summary>
- 17 x 11 inches.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.Legal">
- <summary>
- 8.5 x 14 inches.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.Letter">
- <summary>
- 8.5 x 11 inches.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.EnvelopeDL">
- <summary>
- 110 x 220 mm.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.Quarto">
- <summary>
- 8.47 x 10.83 inches.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.Statement">
- <summary>
- 8.5 x 5.5 inches.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.Tabloid">
- <summary>
- 11 x 17 inches.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.Paper10x14">
- <summary>
- 10 x 14 inches.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.Paper11x17">
- <summary>
- 11 x 17 inches.
- </summary>
- </member>
- <member name="F:Aspose.Words.PaperSize.Custom">
- <summary>
- Custom paper size.
- </summary>
- </member>
- <member name="T:Aspose.Words.Section">
- <summary>
- Represents a single section in a document.
- </summary>
- <remarks>
- <p>
- <b>Section</b> can have one <see cref="P:Aspose.Words.Section.Body" /> and maximum one <see cref="T:Aspose.Words.HeaderFooter" />
- of each <see cref="T:Aspose.Words.HeaderFooterType" />. <b>Body</b> and <b>HeaderFooter</b> nodes
- can be in any order inside <b>Section</b>.</p>
- <p>A minimal valid section needs to have <b>Body</b> with one <b>Paragraph</b>.</p>
- <p>Each section has its own set of properties that specify page size, orientation, margins etc.</p>
- <p>You can create a copy of a section using <see cref="M:Aspose.Words.Node.Clone(System.Boolean)" />. The copy can be inserted into
- the same or different document.</p>
- <p>To add, insert or remove a whole section including section break and
- section properties use methods of the <b>Sections</b> object.</p>
- <p>To copy and insert just content of the section excluding the section break
- and section properties use <b>AppendContent</b> and <b>PrependContent</b> methods.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Section.#ctor(Aspose.Words.DocumentBase)">
- <summary>
- Initializes a new instance of the Section class.
- </summary>
- <remarks>
- <p>When the section is created, it belongs to the specified document, but is not
- yet part of the document and <b>ParentNode</b> is null.</p>
- <p>To include Section into a document use Document.InsertAfter, Document.InsertBefore
- or Sections.Add and Section.Insert methods.</p>
- </remarks>
- <param name="doc">The owner document.</param>
- </member>
- <member name="M:Aspose.Words.Section.Clone">
- <summary>
- Creates a duplicate of this section.
- </summary>
- <dev>Kept to remain compatible with the old API.</dev>
- </member>
- <member name="M:Aspose.Words.Section.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls DocumentVisitor.VisitSectionStart, then calls Accept for all child nodes of the section
- and calls DocumentVisitor.VisitSectionEnd at the end.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Section.PrependContent(Aspose.Words.Section)">
- <summary>
- Inserts a copy of content of the source section at the beginning of this section.
- </summary>
- <remarks>
- <p>Only content of <see cref="P:Aspose.Words.Section.Body" /> of the source section is copied, page setup,
- headers and footers are not copied.</p>
- <p>The nodes are automatically imported if the source section belongs to a different document.</p>
- <p>No new section is created in the destination document.</p>
- </remarks>
- <param name="sourceSection">The section to copy content from.</param>
- </member>
- <member name="M:Aspose.Words.Section.AppendContent(Aspose.Words.Section)">
- <summary>
- Inserts a copy of content of the source section at the end of this section.
- </summary>
- <remarks>
- <p>Only content of <see cref="P:Aspose.Words.Section.Body" /> of the source section is copied, page setup,
- headers and footers are not copied.</p>
- <p>The nodes are automatically imported if the source section belongs to a different document.</p>
- <p>No new section is created in the destination document.</p>
- </remarks>
- <param name="sourceSection">The section to copy content from.</param>
- </member>
- <member name="M:Aspose.Words.Section.ClearContent">
- <summary>
- Clears the section.
- </summary>
- <remarks>
- <p>The text of <see cref="P:Aspose.Words.Section.Body" /> is cleared, only one empty paragraph is left that represents the section break.</p>
- <p>The text of all headers and footers is cleared, but <see cref="T:Aspose.Words.HeaderFooter" /> objects themselves are not removed.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Section.ClearHeadersFooters">
- <summary>
- Clears the headers and footers of this section.
- </summary>
- <remarks>
- <p>The text of all headers and footers is cleared, but <see cref="T:Aspose.Words.HeaderFooter" /> objects themselves are not removed.</p>
- <p>This makes headers and footers of this section linked to headers and footers of the previous section.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Section.DeleteHeaderFooterShapes">
- <summary>
- Deletes all shapes (drawing objects) from the headers and footers of this section.
- </summary>
- </member>
- <member name="M:Aspose.Words.Section.EnsureMinimum">
- <summary>
- Ensures that the section has Body with one Paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.Section.NodeType">
- <summary>
- Returns <b>NodeType.Section</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Section.Body">
- <summary>
- Returns the <b>Body</b> child node of the section.
- </summary>
- <remarks>
- <p>
- <b>Body</b> contains main text of the section.</p>
- <p>Returns null if the section does not have a <b>Body</b> node among its children.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Section.HeadersFooters">
- <summary>
- Provides access to the headers and footers nodes of the section.
- </summary>
- </member>
- <member name="P:Aspose.Words.Section.PageSetup">
- <summary>
- Returns an object that represents page setup and section properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.Section.ProtectedForForms">
- <summary>
- True if the section is protected for forms. When a section is protected for forms,
- users can select and modify text only in form fields in Microsoft Word.
- </summary>
- </member>
- <member name="T:Aspose.Words.SectionCollection">
- <summary>
- A collection of <b>Section</b> objects in the document.
- </summary>
- <remarks>
- <p>A Microsoft Word document can contain multiple sections. To create a section in a Microsoft Word,
- select the Insert/Break command and select a break type. The break specifies whether section starts
- on a new page or on the same page.</p>
- <p>Programmatically inserting and removing sections can be used to customize documents produced
- during mail merge. If a document needs to have different content or parts of the
- content depending on some criteria, then you can create a "master" document that contains
- multiple sections and delete some of the sections before or after mail merge.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.SectionCollection.ToArray">
- <summary>
- Copies all sections from the collection to a new array of sections.
- </summary>
- <returns>An array of sections.</returns>
- </member>
- <member name="P:Aspose.Words.SectionCollection.Item(System.Int32)">
- <summary>
- Retrieves a section at the given index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the list of sections.</param>
- </member>
- <member name="T:Aspose.Words.SectionStart">
- <summary>
- The type of break at the beginning of the section.
- </summary>
- </member>
- <member name="F:Aspose.Words.SectionStart.Continuous">
- <summary>
- The new section starts on the same page as the previous section.
- </summary>
- </member>
- <member name="F:Aspose.Words.SectionStart.NewColumn">
- <summary>
- The section starts from a new column.
- </summary>
- </member>
- <member name="F:Aspose.Words.SectionStart.NewPage">
- <summary>
- The section starts from a new page.
- </summary>
- </member>
- <member name="F:Aspose.Words.SectionStart.EvenPage">
- <summary>
- The section starts on a new even page.
- </summary>
- </member>
- <member name="F:Aspose.Words.SectionStart.OddPage">
- <summary>
- The section starts on a new odd page.
- </summary>
- </member>
- <member name="T:Aspose.Words.Story">
- <summary>
- Base class for elements that contain block-level nodes <see cref="T:Aspose.Words.Paragraph" /> and <see cref="T:Aspose.Words.Tables.Table" />.
- </summary>
- <remarks>
- <p>Text of a Word document is said to consist of several stories.
- The main text is stored in the main text story represented by <see cref="T:Aspose.Words.Body" />,
- each header and footer is stored in a separate story represented by <see cref="T:Aspose.Words.HeaderFooter" />.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Story.DeleteShapes">
- <summary>
- Deletes all shapes from the text of this story.
- </summary>
- </member>
- <member name="M:Aspose.Words.Story.AppendParagraph(System.String)">
- <summary>
- A shortcut method that creates a <see cref="T:Aspose.Words.Paragraph" /> object with optional text and appends it to the end of this object.
- </summary>
- <param name="text">The text for the paragraph. Can be null or empty string.</param>
- <returns>The newly created and appended paragraph.</returns>
- </member>
- <member name="P:Aspose.Words.Story.StoryType">
- <summary>
- Gets the type of this story.
- </summary>
- </member>
- <member name="P:Aspose.Words.Story.FirstParagraph">
- <summary>
- Gets the first paragraph in the story.
- </summary>
- </member>
- <member name="P:Aspose.Words.Story.LastParagraph">
- <summary>
- Gets the last paragraph in the story.
- </summary>
- </member>
- <member name="P:Aspose.Words.Story.Paragraphs">
- <summary>
- Gets a collection of paragraphs that are immediate children of the story.
- </summary>
- </member>
- <member name="P:Aspose.Words.Story.Tables">
- <summary>
- Gets a collection of tables that are immediate children of the story.
- </summary>
- </member>
- <member name="T:Aspose.Words.StoryType">
- <summary>
- Text of a Word document is stored in stories. <b>StoryType</b> identifies a story.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.None">
- <summary>
- Default value. There is no such story in the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.MainText">
- <summary>
- Contains the main text of the document, represented by <see cref="T:Aspose.Words.Body" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.Footnotes">
- <summary>
- Contains footnote text, represented by <see cref="T:Aspose.Words.Footnote" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.Endnotes">
- <summary>
- Contains endnotes text, represented by <see cref="T:Aspose.Words.Footnote" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.Comments">
- <summary>
- Contains document comments (annotations), represented by <see cref="T:Aspose.Words.Comment" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.Textbox">
- <summary>
- Contains shape or textbox text, represented by <see cref="T:Aspose.Words.Drawing.Shape" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.EvenPagesHeader">
- <summary>
- Contains text of the even pages header, represented by <see cref="T:Aspose.Words.HeaderFooter" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.PrimaryHeader">
- <summary>
- Contains text of the primary header. When header is different for odd and even pages,
- contains text of the odd pages header. Represented by <see cref="T:Aspose.Words.HeaderFooter" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.EvenPagesFooter">
- <summary>
- Contains text of the even pages footer, represented by <see cref="T:Aspose.Words.HeaderFooter" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.PrimaryFooter">
- <summary>
- Contains text of the primary footer. When footer is different for odd and even pages,
- contains text of the odd pages footer. Represented by <see cref="T:Aspose.Words.HeaderFooter" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.FirstPageHeader">
- <summary>
- Contains text of the first page header, represented by <see cref="T:Aspose.Words.HeaderFooter" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.FirstPageFooter">
- <summary>
- Contains text of the first page footer, represented by <see cref="T:Aspose.Words.HeaderFooter" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.FootnoteSeparator">
- <summary>
- Contains the text of the footnote separator, represented by <see cref="T:Aspose.Words.FootnoteSeparator" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.FootnoteContinuationSeparator">
- <summary>
- Contains the text of the footnote continuation separator, represented by <see cref="T:Aspose.Words.FootnoteSeparator" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.FootnoteContinuationNotice">
- <summary>
- Contains the text of the footnote continuation notice separator, represented by <see cref="T:Aspose.Words.FootnoteSeparator" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.EndnoteSeparator">
- <summary>
- Contains the text of the endnote separator, represented by <see cref="T:Aspose.Words.FootnoteSeparator" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.EndnoteContinuationSeparator">
- <summary>
- Contains the text of the endnote continuation separator, represented by <see cref="T:Aspose.Words.FootnoteSeparator" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.StoryType.EndnoteContinuationNotice">
- <summary>
- Contains the text of the endnote continuation notice separator, represented by <see cref="T:Aspose.Words.FootnoteSeparator" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.TextColumn">
- <summary>
- Represents a single text column. <b>TextColumn</b> is a member of the <see cref="T:Aspose.Words.TextColumnCollection" /> collection.
- The <b>TextColumns</b> collection includes all the columns in a section of a document.
- </summary>
- <remarks>
- <p>
- <b>TextColumn</b> objects are only used to specify columns with custom width and spacing. If you want
- the columns in the document to be of equal width, set TextColumns.<see cref="P:Aspose.Words.TextColumnCollection.EvenlySpaced" /> to <b>true</b>.</p>
- <p>When a new <b>TextColumn</b> is created it has its width and spacing set to zero.</p>
- <seealso cref="T:Aspose.Words.TextColumnCollection" />
- <seealso cref="T:Aspose.Words.PageSetup" />
- <seealso cref="T:Aspose.Words.Section" />
- </remarks>
- <dev>
- This is both a presentation and a model class. Represents width and spacing of a single column
- in a section. Only used for custom width columns (not for evenly spaced columns).
- </dev>
- </member>
- <member name="P:Aspose.Words.TextColumn.Width">
- <summary>
- Gets or sets the width of the text column in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.TextColumn.SpaceAfter">
- <summary>
- Gets or sets the space between this column and the next column in points. Not required for the last column.
- </summary>
- </member>
- <member name="T:Aspose.Words.TextColumnCollection">
- <summary>
- A collection of <see cref="T:Aspose.Words.TextColumn" /> objects that represent all the columns of text in a section of a document.
- </summary>
- <remarks>
- <p>Use <see cref="M:Aspose.Words.TextColumnCollection.SetCount(System.Int32)" /> to set the number of text columns.</p>
- <p>To make all columns equal width and spaced evenly, set <see cref="P:Aspose.Words.TextColumnCollection.EvenlySpaced" /> to <b>true</b>
- and specify the amount of space between the columns in <see cref="P:Aspose.Words.TextColumnCollection.Spacing" />. MS Word will
- automatically calculate column widths.</p>
- <p>If you have <b>EvenlySpaced</b> set to <b>false</b>, you need to specify width and spacing for each
- column individually. Use the indexer to access individual <see cref="T:Aspose.Words.TextColumn" /> objects.</p>
- <p>When using custom column widths, make sure the sum of all column widths and spacings between them
- equals page width minus left and right page margins.</p>
- <seealso cref="T:Aspose.Words.PageSetup" />
- <seealso cref="T:Aspose.Words.Section" />
- </remarks>
- <dev>
- This is a pure presentation class. Does not store any model data, just provides friendly
- access to section attributes that are related to managing text columns.
- </dev>
- </member>
- <member name="M:Aspose.Words.TextColumnCollection.SetCount(System.Int32)">
- <summary>
- Arranges text into the specified number of text columns.
- </summary>
- <remarks>
- <p>When <see cref="P:Aspose.Words.TextColumnCollection.EvenlySpaced" /> is <b>false</b> and you increase the number of columns,
- new <see cref="T:Aspose.Words.TextColumn" /> objects are created with zero width and spacing.
- You need to set width and spacing for the new columns.</p>
- </remarks>
- <param name="newCount">The number of columns the text is to be arranged into.</param>
- </member>
- <member name="P:Aspose.Words.TextColumnCollection.EvenlySpaced">
- <summary>
- <b>True</b> if text columns are of equal width and evenly spaced.
- </summary>
- </member>
- <member name="P:Aspose.Words.TextColumnCollection.Spacing">
- <summary>
- When columns are evenly spaced, gets or sets the amount of space between each column in points.
- </summary>
- <remarks>
- Has effect only when <see cref="P:Aspose.Words.TextColumnCollection.EvenlySpaced" /> is set to <b>true</b>.
- </remarks>
- </member>
- <member name="P:Aspose.Words.TextColumnCollection.Width">
- <summary>
- When columns are evenly spaced, gets the width of the columns.
- </summary>
- <remarks>
- <p>Has effect only when <see cref="P:Aspose.Words.TextColumnCollection.EvenlySpaced" /> is set to <b>true</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.TextColumnCollection.LineBetween">
- <summary>
- When <b>true</b>, adds a vertical line between columns.
- </summary>
- </member>
- <member name="P:Aspose.Words.TextColumnCollection.Count">
- <summary>
- Gets the number of columns in the section of a document.
- </summary>
- </member>
- <member name="P:Aspose.Words.TextColumnCollection.Item(System.Int32)">
- <summary>
- Returns a text column at the specified index.
- </summary>
- </member>
- <member name="T:Aspose.Words.Style">
- <summary>
- Represents a single built-in or user-defined style.
- </summary>
- </member>
- <member name="M:Aspose.Words.Style.Remove">
- <summary>
- Removes the specified style from the document.
- </summary>
- <remarks>
- Style removal has following effects on the document model:
- <list type="bullet"><item>All references to the style are removed from corresponding paragraphs, runs and tables.</item><item>If base style is removed its formatting is moved to child styles.</item><item>If style to be deleted has a linked style, then both of these are deleted.</item></list></remarks>
- </member>
- <member name="M:Aspose.Words.Style.Equals(Aspose.Words.Style)">
- <summary>
- Compares with the specified style.
- Styles Istds are compared for built-in styles only.
- Styles defaults are not included in comparison.
- Base style, linked style and next paragraph style are recursively compared.
- </summary>
- </member>
- <member name="M:Aspose.Words.Style.Equals(Aspose.Words.Style,Aspose.Collections.Generic.HashSetGeneric{Aspose.Pair})">
- <summary>
- Compares with the specified style considering base, linked and next paragraph styles.
- Uses HashSet to check already compared styles to avoid dead loops in linked and next styles.
- </summary>
- </member>
- <member name="P:Aspose.Words.Style.Name">
- <summary>
- Gets or sets the name of the style.
- </summary>
- <remarks>
- <p>Can not be empty string.</p>
- <p>If there already is a style with such name in the collection, then this style will override it. All affected nodes will reference new style.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Style.StyleIdentifier">
- <summary>
- Gets the locale independent style identifier for a built-in style.
- </summary>
- <remarks>
- <para>For user defined (custom) styles, this property returns <see cref="F:Aspose.Words.StyleIdentifier.User" />.</para>
- <seealso cref="P:Aspose.Words.Style.Name" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Style.Aliases">
- <summary>
- Gets all aliases of this style. If style has no aliases then empty array of string is returned.
- </summary>
- </member>
- <member name="P:Aspose.Words.Style.IsHeading">
- <summary>
- True when the style is one of the built-in Heading styles.
- </summary>
- </member>
- <member name="P:Aspose.Words.Style.Type">
- <summary>
- Gets the style type (paragraph or character).
- </summary>
- </member>
- <member name="P:Aspose.Words.Style.Document">
- <summary>
- Gets the owner document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Style.LinkedStyleName">
- <summary>
- Gets the name of the Style linked to this one. Returns Empty string if no styles are linked.
- </summary>
- </member>
- <member name="P:Aspose.Words.Style.BaseStyleName">
- <summary>
- Gets/sets the name of the style this style is based on.
- </summary>
- <remarks>
- This will be an empty string if the style is not based on any other style and it can be set
- to an empty string.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Style.NextParagraphStyleName">
- <summary>
- Gets/sets the name of the style to be applied automatically to a new paragraph inserted after a
- paragraph formatted with the specified style.
- </summary>
- <remarks>
- This property is not used by Aspose.Words. The next paragraph style will only
- be applied automatically when you edit the document in MS Word.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Style.BuiltIn">
- <summary>
- True if this style is one of the built-in styles in MS Word.
- </summary>
- </member>
- <member name="P:Aspose.Words.Style.Font">
- <summary>
- Gets the character formatting of the style.
- </summary>
- <remarks>
- <para>For list styles this property returns null.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Style.ParagraphFormat">
- <summary>
- Gets the paragraph formatting of the style.
- </summary>
- <remarks>
- <para>For character and list styles this property returns null.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Style.List">
- <summary>
- Gets the list that defines formatting of this list style.
- </summary>
- <remarks>
- <para>This property is only valid for list styles.
- For other style types this property returns null.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Style.ListFormat">
- <summary>
- Provides access to the list formatting properties of a paragraph style.
- </summary>
- <remarks>
- <para>This property is only valid for paragraph styles.
- For other style types this property returns null.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Style.IsQuickStyle">
- <summary>
- Specifies whether this style is shown in the Quick Style gallery inside MS Word UI.
- </summary>
- </member>
- <member name="P:Aspose.Words.Style.Styles">
- <summary>
- Gets the collection of styles this style belongs to.
- </summary>
- </member>
- <member name="T:Aspose.Words.StyleIdentifier">
- <summary>
- Locale independent style identifier.
- </summary>
- <remarks>
- <p>The names of built-in styles in MS Word are localized for different languages.
- Using a style identifier you can find the correct style regardless of the document language.</p>
- <p>All user defined styles are assigned the StyleIdentifier.User value.</p>
- </remarks>
- <dev>DO NOT RENUMBER! These values are important for DOC import/export.</dev>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.BookTitle">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.CommentReference">
- <summary>
- The Annotation (Comment) Reference style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.DefaultParagraphFont">
- <summary>
- The Default Paragraph Font style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Emphasis">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.EndnoteReference">
- <summary>
- The Endnote Reference style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.FollowedHyperlink">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.FootnoteReference">
- <summary>
- The Footnote Reference style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.HtmlAcronym">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.HtmlCite">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.HtmlCode">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.HtmlDefinition">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.HtmlKeyboard">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.HtmlSample">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.HtmlTypewriter">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.HtmlVariable">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Hyperlink">
- <summary>
- The Hyperlink style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.IntenseEmphasis">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.IntenseReference">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LineNumber">
- <summary>
- The Line Number style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.PageNumber">
- <summary>
- The Page Number style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.PlaceholderText">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Strong">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.SubtleEmphasis">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.SubtleReference">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.BalloonText">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.BodyText">
- <summary>
- The Body Text style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.BodyText2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.BodyText3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.BodyText1I">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.BodyText1I2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.BodyTextInd">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.BodyTextInd2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.BodyTextInd3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Closing">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.CommentSubject">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.CommentText">
- <summary>
- The Annotation (Comment) Text style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Date">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.DocumentMap">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.EmailSignature">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.EndnoteText">
- <summary>
- The Endnote Text style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Footer">
- <summary>
- The Footer style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.FootnoteText">
- <summary>
- The Footnote Text style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Header">
- <summary>
- The Header style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Heading1">
- <summary>
- The Heading 1 style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Heading2">
- <summary>
- The Heading 2 style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Heading3">
- <summary>
- The Heading 3 style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Heading4">
- <summary>
- The Heading 4 style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Heading5">
- <summary>
- The Heading 5 style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Heading6">
- <summary>
- The Heading 6 style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Heading7">
- <summary>
- The Heading 7 style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Heading8">
- <summary>
- The Heading 8 style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Heading9">
- <summary>
- The Heading 9 style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.HtmlAddress">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.HtmlTopOfForm">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.HtmlBottomOfForm">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.HtmlPreformatted">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.IntenseQuote">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Macro">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MessageHeader">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.NoteHeading">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.PlainText">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Quote">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Salutation">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Signature">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Subtitle">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Title">
- <summary>
- The Title style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Bibliography">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.BlockText">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Caption">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.EnvelopeAddress">
- <summary>
- The Envelope Address style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.EnvelopeReturn">
- <summary>
- The Envelope Return style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Index1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Index2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Index3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Index4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Index5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Index6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Index7">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Index8">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Index9">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.IndexHeading">
- <summary>
- The Index Heading style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.List">
- <summary>
- The List style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.List2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.List3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.List4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.List5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListBullet">
- <summary>
- The List Bullet style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListBullet2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListBullet3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListBullet4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListBullet5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListContinue">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListContinue2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListContinue3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListContinue4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListContinue5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListNumber">
- <summary>
- The List Number style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListNumber2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListNumber3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListNumber4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListNumber5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListParagraph">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.NoSpacing">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Normal">
- <summary>
- The Normal style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.NormalWeb">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.NormalIndent">
- <summary>
- The Normal Indent style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableOfAuthorities">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableOfFigures">
- <summary>
- The Table of Figures style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ToaHeading">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Toc1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Toc2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Toc3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Toc4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Toc5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Toc6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Toc7">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Toc8">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Toc9">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TocHeading">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Revision">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.OutlineList1">
- <summary>
- The 1 / a / i style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.OutlineList2">
- <summary>
- The 1 / 1.1 / 1.1.1 style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.OutlineList3">
- <summary>
- The Article / Section style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.NoList">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulGrid">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulGridAccent1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulGridAccent2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulGridAccent3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulGridAccent4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulGridAccent5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulGridAccent6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulList">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulListAccent1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulListAccent2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulListAccent3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulListAccent4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulListAccent5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulListAccent6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulShading">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulShadingAccent1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulShadingAccent2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulShadingAccent3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulShadingAccent4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulShadingAccent5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ColorfulShadingAccent6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.DarkList">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.DarkListAccent1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.DarkListAccent2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.DarkListAccent3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.DarkListAccent4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.DarkListAccent5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.DarkListAccent6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightGrid">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightGridAccent1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightGridAccent2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightGridAccent3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightGridAccent4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightGridAccent5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightGridAccent6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightList">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightListAccent1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightListAccent2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightListAccent3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightListAccent4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightListAccent5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightListAccent6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightShading">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightShadingAccent1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightShadingAccent2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightShadingAccent3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightShadingAccent4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightShadingAccent5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.LightShadingAccent6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid1Accent1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid1Accent2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid1Accent3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid1Accent4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid1Accent5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid1Accent6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid2Accent1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid2Accent2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid2Accent3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid2Accent4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid2Accent5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid2Accent6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid3Accent1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid3Accent2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid3Accent3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid3Accent4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid3Accent5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumGrid3Accent6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumList1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumList1Accent1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumList1Accent2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumList1Accent3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumList1Accent4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumList1Accent5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumList1Accent6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumList2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumList2Accent1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumList2Accent2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumList2Accent3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumList2Accent4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumList2Accent5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumList2Accent6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumShading1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumShading1Accent1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumShading1Accent2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumShading1Accent3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumShading1Accent4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumShading1Accent5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumShading1Accent6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumShading2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumShading2Accent1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumShading2Accent2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumShading2Accent3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumShading2Accent4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumShading2Accent5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.MediumShading2Accent6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Table3DEffects1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Table3DEffects2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Table3DEffects3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableClassic1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableClassic2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableClassic3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableClassic4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableColorful1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableColorful2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableColorful3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableColumns1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableColumns2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableColumns3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableColumns4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableColumns5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableContemporary">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableElegant">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableGrid">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableGrid1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableGrid2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableGrid3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableGrid4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableGrid5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableGrid6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableGrid7">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableGrid8">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableList1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableList2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableList3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableList4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableList5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableList6">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableList7">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableList8">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableNormal">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableProfessional">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableSimple1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableSimple2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableSimple3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableSubtle1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableSubtle2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableTheme">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableWeb1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableWeb2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableWeb3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.PlainTable1">
- <summary>
- Plain Table 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.PlainTable2">
- <summary>
- Plain Table 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.PlainTable3">
- <summary>
- Plain Table 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.PlainTable4">
- <summary>
- Plain Table 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.PlainTable5">
- <summary>
- Plain Table 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.TableGridLight">
- <summary>
- Table Grid Light
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable1Light">
- <summary>
- Grid Table 1 Light
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable2">
- <summary>
- Grid Table 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable3">
- <summary>
- Grid Table 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable4">
- <summary>
- Grid Table 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable5Dark">
- <summary>
- Grid Table 5 Dark
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable6Colorful">
- <summary>
- Grid Table 6 Colorful
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable7Colorful">
- <summary>
- Grid Table 7 Colorful
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable1LightAccent1">
- <summary>
- Grid Table 1 Light - Accent 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable2Accent1">
- <summary>
- Grid Table 2 - Accent 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable3Accent1">
- <summary>
- Grid Table 3 - Accent 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable4Accent1">
- <summary>
- Grid Table 4 - Accent 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable5DarkAccent1">
- <summary>
- Grid Table 5 Dark - Accent 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable6ColorfulAccent1">
- <summary>
- Grid Table 6 Colorful - Accent 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable7ColorfulAccent1">
- <summary>
- Grid Table 7 Colorful - Accent 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable1LightAccent2">
- <summary>
- Grid Table 1 Light - Accent 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable2Accent2">
- <summary>
- Grid Table 2 - Accent 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable3Accent2">
- <summary>
- Grid Table 3 - Accent 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable4Accent2">
- <summary>
- Grid Table 4 - Accent 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable5DarkAccent2">
- <summary>
- Grid Table 5 Dark - Accent 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable6ColorfulAccent2">
- <summary>
- Grid Table 6 Colorful - Accent 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable7ColorfulAccent2">
- <summary>
- Grid Table 7 Colorful - Accent 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable1LightAccent3">
- <summary>
- Grid Table 1 Light - Accent 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable2Accent3">
- <summary>
- Grid Table 2 - Accent 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable3Accent3">
- <summary>
- Grid Table 3 - Accent 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable4Accent3">
- <summary>
- Grid Table 4 - Accent 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable5DarkAccent3">
- <summary>
- Grid Table 5 Dark - Accent 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable6ColorfulAccent3">
- <summary>
- Grid Table 6 Colorful - Accent 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable7ColorfulAccent3">
- <summary>
- Grid Table 7 Colorful - Accent 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable1LightAccent4">
- <summary>
- Grid Table 1 Light - Accent 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable2Accent4">
- <summary>
- Grid Table 2 - Accent 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable3Accent4">
- <summary>
- Grid Table 3 - Accent 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable4Accent4">
- <summary>
- Grid Table 4 - Accent 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable5DarkAccent4">
- <summary>
- Grid Table 5 Dark - Accent 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable6ColorfulAccent4">
- <summary>
- Grid Table 6 Colorful - Accent 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable7ColorfulAccent4">
- <summary>
- Grid Table 7 Colorful - Accent 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable1LightAccent5">
- <summary>
- Grid Table 1 Light - Accent 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable2Accent5">
- <summary>
- Grid Table 2 - Accent 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable3Accent5">
- <summary>
- Grid Table 3 - Accent 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable4Accent5">
- <summary>
- Grid Table 4 - Accent 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable5DarkAccent5">
- <summary>
- Grid Table 5 Dark - Accent 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable6ColorfulAccent5">
- <summary>
- Grid Table 6 Colorful - Accent 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable7ColorfulAccent5">
- <summary>
- Grid Table 7 Colorful - Accent 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable1LightAccent6">
- <summary>
- Grid Table 1 Light - Accent 6
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable2Accent6">
- <summary>
- Grid Table 2 - Accent 6
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable3Accent6">
- <summary>
- Grid Table 3 - Accent 6
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable4Accent6">
- <summary>
- Grid Table 4 - Accent 6
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable5DarkAccent6">
- <summary>
- Grid Table 5 Dark - Accent 6
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable6ColorfulAccent6">
- <summary>
- Grid Table 6 Colorful - Accent 6
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.GridTable7ColorfulAccent6">
- <summary>
- Grid Table 7 Colorful - Accent 6
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable1Light">
- <summary>
- List Table 1 Light
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable2">
- <summary>
- List Table 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable3">
- <summary>
- List Table 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable4">
- <summary>
- List Table 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable5Dark">
- <summary>
- List Table 5 Dark
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable6Colorful">
- <summary>
- List Table 6 Colorful
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable7Colorful">
- <summary>
- List Table 7 Colorful
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable1LightAccent1">
- <summary>
- List Table 1 Light - Accent 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable2Accent1">
- <summary>
- List Table 2 - Accent 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable3Accent1">
- <summary>
- List Table 3 - Accent 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable4Accent1">
- <summary>
- List Table 4 - Accent 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable5DarkAccent1">
- <summary>
- List Table 5 Dark - Accent 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable6ColorfulAccent1">
- <summary>
- List Table 6 Colorful - Accent 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable7ColorfulAccent1">
- <summary>
- List Table 7 Colorful - Accent 1
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable1LightAccent2">
- <summary>
- List Table 1 Light - Accent 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable2Accent2">
- <summary>
- List Table 2 - Accent 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable3Accent2">
- <summary>
- List Table 3 - Accent 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable4Accent2">
- <summary>
- List Table 4 - Accent 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable5DarkAccent2">
- <summary>
- List Table 5 Dark - Accent 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable6ColorfulAccent2">
- <summary>
- List Table 6 Colorful - Accent 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable7ColorfulAccent2">
- <summary>
- List Table 7 Colorful - Accent 2
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable1LightAccent3">
- <summary>
- List Table 1 Light - Accent 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable2Accent3">
- <summary>
- List Table 2 - Accent 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable3Accent3">
- <summary>
- List Table 3 - Accent 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable4Accent3">
- <summary>
- List Table 4 - Accent 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable5DarkAccent3">
- <summary>
- List Table 5 Dark - Accent 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable6ColorfulAccent3">
- <summary>
- List Table 6 Colorful - Accent 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable7ColorfulAccent3">
- <summary>
- List Table 7 Colorful - Accent 3
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable1LightAccent4">
- <summary>
- List Table 1 Light - Accent 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable2Accent4">
- <summary>
- List Table 2 - Accent 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable3Accent4">
- <summary>
- List Table 3 - Accent 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable4Accent4">
- <summary>
- List Table 4 - Accent 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable5DarkAccent4">
- <summary>
- List Table 5 Dark - Accent 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable6ColorfulAccent4">
- <summary>
- List Table 6 Colorful - Accent 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable7ColorfulAccent4">
- <summary>
- List Table 7 Colorful - Accent 4
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable1LightAccent5">
- <summary>
- List Table 1 Light - Accent 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable2Accent5">
- <summary>
- List Table 2 - Accent 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable3Accent5">
- <summary>
- List Table 3 - Accent 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable4Accent5">
- <summary>
- List Table 4 - Accent 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable5DarkAccent5">
- <summary>
- List Table 5 Dark - Accent 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable6ColorfulAccent5">
- <summary>
- List Table 6 Colorful - Accent 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable7ColorfulAccent5">
- <summary>
- List Table 7 Colorful - Accent 5
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable1LightAccent6">
- <summary>
- List Table 1 Light - Accent 6
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable2Accent6">
- <summary>
- List Table 2 - Accent 6
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable3Accent6">
- <summary>
- List Table 3 - Accent 6
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable4Accent6">
- <summary>
- List Table 4 - Accent 6
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable5DarkAccent6">
- <summary>
- List Table 5 Dark - Accent 6
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable6ColorfulAccent6">
- <summary>
- List Table 6 Colorful - Accent 6
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.ListTable7ColorfulAccent6">
- <summary>
- List Table 7 Colorful - Accent 6
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.User">
- <summary>
- A user defined style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleIdentifier.Nil">
- <summary>
- Reserved for internal use.
- </summary>
- </member>
- <member name="T:Aspose.Words.StyleCollection">
- <summary>
- A collection of Style objects that represent both the built-in and user-defined styles in a document.
- </summary>
- <dev>
- At the moment the styles are identified by istd (style index) that never changes (it only changes
- when importing a style from another document). Will it be better if I used a string name as an
- identifier? Note however, it should not change once it has been assigned, otherwise will need to
- update all references to the style in the model.
- </dev>
- </member>
- <member name="M:Aspose.Words.StyleCollection.GetEnumerator">
- <summary>
- Gets an enumerator object that will enumerate styles in the alphabetical order of their names.
- </summary>
- </member>
- <member name="M:Aspose.Words.StyleCollection.Add(Aspose.Words.StyleType,System.String)">
- <summary>
- Creates a new user defined style and adds it the collection.
- </summary>
- <remarks>
- <p>You can create character, paragraph or a list style.</p>
- <p>When creating a list style, the style is created with default numbered list formatting (1 \ a \ i).</p>
- <p>Throws an exception if a style with this name already exists.</p>
- </remarks>
- <param name="type">A <see cref="T:Aspose.Words.StyleType" /> value that specifies the type of the style to create.</param>
- <param name="name">Case sensitive name of the style to create.</param>
- </member>
- <member name="M:Aspose.Words.StyleCollection.Add(Aspose.Words.Style)">
- <summary>
- Adds the style to the collection of styles.
- </summary>
- </member>
- <member name="M:Aspose.Words.StyleCollection.AddCopy(Aspose.Words.Style)">
- <summary>
- Copies a style into this collection.
- </summary>
- <param name="style">Style to be copied.</param>
- <returns>Copied style ready for usage.</returns>
- <remarks>
- <para>Style to be copied can belong to the same document as well as to different document.</para>
- <para>Linked style is copied.</para>
- <para>This method does doesn't copy base styles.</para>
- <para>If collection already contains a style with the same name, then new name is
- automatically generated by adding "_number" suffix starting from 0 e.g. "Normal_0", "Heading 1_1" etc.
- Use <see cref="P:Aspose.Words.Style.Name" /> setter for changing the name of the imported style.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.StyleCollection.Document">
- <summary>
- Gets the owner document.
- </summary>
- </member>
- <member name="P:Aspose.Words.StyleCollection.DefaultFont">
- <summary>
- Gets document default text formatting.
- </summary>
- <remarks>
- <p>Note that document-wide defaults were introduced in Microsoft Word 2007 and are fully supported in OOXML formats (<see cref="F:Aspose.Words.LoadFormat.Docx" />) only.
- Earlier document formats have limited support for this feature and only font names can be stored.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.StyleCollection.DefaultParagraphFormat">
- <summary>
- Gets document default paragraph formatting.
- </summary>
- <remarks>
- <p>Note that document-wide defaults were introduced in Microsoft Word 2007 and are fully supported in OOXML formats (<see cref="F:Aspose.Words.LoadFormat.Docx" />) only.
- Earlier document formats have no support for document default paragraph formatting.</p>
- </remarks>
- <dev>
- Default paragraph formatting is copied to all top level styles when it is not supported in target document format.
- </dev>
- </member>
- <member name="P:Aspose.Words.StyleCollection.Count">
- <summary>
- Gets the number of styles in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.StyleCollection.Item(System.String)">
- <overloads>Retrieves a style from the collection.</overloads>
- <summary>
- Gets a style by name or alias.
- </summary>
- <remarks>
- <p>Case sensitive, returns null if the style with the given name is not found.</p>
- <p>If this is an English name of a built in style that does not yet exist, automatically creates it.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.StyleCollection.Item(Aspose.Words.StyleIdentifier)">
- <summary>
- Gets a built-in style by its locale independent identifier.
- </summary>
- <remarks>
- <p>When accessing a style that does not yet exist, automatically creates it.</p>
- </remarks>
- <param name="sti">A <see cref="T:Aspose.Words.StyleIdentifier" /> value that specifies the built in style to retrieve.</param>
- </member>
- <member name="P:Aspose.Words.StyleCollection.Item(System.Int32)">
- <summary>
- Gets a style by index.
- </summary>
- <dev>
- Gets by index, not by istd.
- </dev>
- </member>
- <member name="T:Aspose.Words.StyleType">
- <summary>
- Represents type of the style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleType.Paragraph">
- <summary>
- The style is a paragraph style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleType.Character">
- <summary>
- The style is a character style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleType.Table">
- <summary>
- The style is a table style.
- </summary>
- </member>
- <member name="F:Aspose.Words.StyleType.List">
- <summary>
- The style is a list style.
- </summary>
- </member>
- <member name="T:Aspose.Words.Comment">
- <summary>
- Represents a container for text of a comment.
- </summary>
- <remarks>
- <para>A comment is an annotation which is anchored to a region of text or to a position in text.
- A comment can contain an arbitrary amount of block-level content.</para>
- <para>If a <see cref="T:Aspose.Words.Comment" /> object occurs on its own, the comment is anchored to
- the position of the <see cref="T:Aspose.Words.Comment" /> object.</para>
- <para>To anchor a comment to a region of text three objects are required: <see cref="T:Aspose.Words.Comment" />,
- <see cref="T:Aspose.Words.CommentRangeStart" /> and <see cref="T:Aspose.Words.CommentRangeEnd" />. All three objects need to share the same
- <see cref="P:Aspose.Words.Comment.Id" /> value.</para>
- <p>
- <see cref="T:Aspose.Words.Comment" /> is an inline-level node and can only be a child of <see cref="T:Aspose.Words.Paragraph" />.</p>
- <p>
- <see cref="T:Aspose.Words.Comment" /> can contain <see cref="T:Aspose.Words.Paragraph" /> and <see cref="T:Aspose.Words.Tables.Table" /> child nodes.</p>
- <seealso cref="T:Aspose.Words.CommentRangeStart" />
- <seealso cref="T:Aspose.Words.CommentRangeEnd" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Comment.#ctor(Aspose.Words.DocumentBase,Aspose.Words.RunPr)">
- <summary>
- Main ctor used internally.
- </summary>
- </member>
- <member name="M:Aspose.Words.Comment.#ctor(Aspose.Words.DocumentBase)">
- <summary>
- Initializes a new instance of the <b>Comment</b> class.
- </summary>
- <remarks>
- <p>When <b>Comment</b> is created, it belongs to the specified document, but is not
- yet part of the document and <b>ParentNode</b> is null.</p>
- <p>To append <b>Comment</b> to the document use InsertAfter or InsertBefore
- on the paragraph where you want the comment inserted.</p>
- <para>After creating a comment, don't forget to set its <see cref="P:Aspose.Words.Comment.Author" />,
- <see cref="P:Aspose.Words.Comment.Initial" /> and <see cref="P:Aspose.Words.Comment.DateTime" /> properties.</para>
- </remarks>
- <param name="doc">The owner document.</param>
- </member>
- <member name="M:Aspose.Words.Comment.#ctor(Aspose.Words.DocumentBase,System.String,System.String,System.DateTime)">
- <summary>
- Initializes a new instance of the <b>Comment</b> class.
- </summary>
- <param name="doc">The owner document.</param>
- <param name="author">The author name for the comment. Cannot be null.</param>
- <param name="initial">The author initials for the comment. Cannot be null.</param>
- <param name="dateTime">The date and time for the comment.</param>
- </member>
- <member name="M:Aspose.Words.Comment.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitCommentStart(Aspose.Words.Comment)" />, then calls <see cref="M:Aspose.Words.Node.Accept(Aspose.Words.DocumentVisitor)" /> for all
- child nodes of the comment and calls <see cref="M:Aspose.Words.DocumentVisitor.VisitCommentEnd(Aspose.Words.Comment)" /> at the end.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Comment.AddReply(System.String,System.String,System.DateTime,System.String)">
- <summary>
- Adds a reply to this comment.
- </summary>
- <param name="author">The author name for the reply.</param>
- <param name="initial">The author initials for the reply.</param>
- <param name="dateTime">The date and time for the reply.</param>
- <param name="text">The reply text.</param>
- <returns>The created <see cref="T:Aspose.Words.Comment" /> node for the reply.</returns>
- <remarks>
- Due to the existing MS Office limitations only 1 level of replies is allowed in the document.
- An exception of type <see cref="T:System.InvalidOperationException" /> will be raised if this method is
- called on the existing Reply comment.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Comment.RemoveReply(Aspose.Words.Comment)">
- <summary>
- Removes the specified reply to this comment.
- </summary>
- <remarks>All constituent nodes of the reply will be deleted from the document.</remarks>
- <param name="reply">The comment node of the deleting reply.</param>
- </member>
- <member name="M:Aspose.Words.Comment.RemoveAllReplies">
- <summary>
- Removes all replies to this comment.
- </summary>
- <remarks> All constituent nodes of the replies will be deleted from the document.</remarks>
- </member>
- <member name="M:Aspose.Words.Comment.SetText(System.String)">
- <summary>
- This is a convenience method that allows to easily set text of the comment.
- </summary>
- <remarks>
- <para>This method allows to quickly set text of a comment from a string. The string can contain
- paragraph breaks, this will create paragraphs of text in the comment accordingly.
- If you want to insert more complex elements into the comment, for example bookmarks
- or tables or apply rich formatting, then you need to use the appropriate node classes to
- build up the comment text.</para>
- </remarks>
- <param name="text">The new text of the comment.</param>
- </member>
- <member name="P:Aspose.Words.Comment.NodeType">
- <summary>
- Returns <b>NodeType.Comment</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Comment.StoryType">
- <summary>
- Returns <b>StoryType.Comments</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Comment.Id">
- <summary>
- Gets the comment identifier.
- </summary>
- <remarks>
- <para>The comment identifier allows to anchor a comment to a region of text in the document.
- The region must be demarcated using the <see cref="T:Aspose.Words.CommentRangeStart" /> and <see cref="T:Aspose.Words.CommentRangeEnd" />
- object sharing the same identifier value as the <see cref="T:Aspose.Words.Comment" /> object.</para>
- <para>You would use this value when looking for the <see cref="T:Aspose.Words.CommentRangeStart" /> and
- <see cref="T:Aspose.Words.CommentRangeEnd" /> nodes that are linked to this comment.</para>
- <para>Comment identifiers are supposed to be unique across a document and Aspose.Words automatically
- maintains comment identifiers when loading, saving and combining documents.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Comment.Initial">
- <summary>
- Returns or sets the initials of the user associated with a specific comment.
- </summary>
- <remarks>
- <para>Cannot be null.</para>
- <para>Default is empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Comment.DateTime">
- <summary>
- Gets the date and time that the comment was made.
- </summary>
- <remarks>
- <para>Default is <see cref="F:System.DateTime.MinValue" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Comment.Author">
- <summary>
- Returns or sets the author name for a comment.
- </summary>
- <remarks>
- <para>Cannot be null.</para>
- <para>Default is empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Comment.Ancestor">
- <summary>
- Returns the parent Comment object. Returns null for top-level comments.
- </summary>
- </member>
- <member name="P:Aspose.Words.Comment.Replies">
- <summary>
- Returns a collection of <see cref="T:Aspose.Words.Comment" /> objects that are immediate children of the specified comment.
- </summary>
- </member>
- <member name="P:Aspose.Words.Comment.Done">
- <summary>
- Gets or sets flag indicating that the comment has been marked done.
- </summary>
- </member>
- <member name="T:Aspose.Words.ControlChar">
- <summary>
- Control characters often encountered in documents.
- </summary>
- <remarks>
- Provides both char and string versions of the same constants. For example:
- string ControlChar.LineBreak and char ControlChar.LineBreakChar have the same value.
- </remarks>
- </member>
- <member name="F:Aspose.Words.ControlChar.CellChar">
- <summary>
- End of a table cell or end of a table row character: (char)7 or "\a".
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.TabChar">
- <summary>
- Tab character: (char)9 or "\t".
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.LineFeedChar">
- <summary>
- Line feed character: (char)10 or "\n".
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.LineBreakChar">
- <summary>
- Line break character: (char)11 or "\v".
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.PageBreakChar">
- <summary>
- Page break character: (char)12 or "\f".
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.SectionBreakChar">
- <summary>
- End of section character: (char)12 or "\f".
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.ParagraphBreakChar">
- <summary>
- End of paragraph character: (char)13 or "\r".
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.ColumnBreakChar">
- <summary>
- End of column character: (char)14.
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.FieldStartChar">
- <summary>
- Start of MS Word field character: (char)19.
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.FieldSeparatorChar">
- <summary>
- Field separator character separates field code from field value. Optional in some fields. Value: (char)20.
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.FieldEndChar">
- <summary>
- End of MS Word field character: (char)21.
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.NonBreakingHyphenChar">
- <summary>
- Nonbreaking Hyphen in Microsoft Word is (char)30.
- </summary>
- <remarks>
- <p>Nonbreaking Hyphen in Microsoft Word does not correspond to the
- Unicode character U+2011 non-breaking hyphen but instead represents
- internal information that tells Microsoft Word to display a hyphen and not to break a line.</p>
- <p>Useful info: http://www.cs.tut.fi/~jkorpela/dashes.html#linebreaks.</p>
- </remarks>
- </member>
- <member name="F:Aspose.Words.ControlChar.OptionalHyphenChar">
- <summary>
- Optional Hyphen in Microsoft Word is (char)31.
- </summary>
- <remarks>
- <p>Optional Hyphen in Microsoft Word does not correspond to the Unicode character U+00AD soft hyphen.
- Instead, it inserts internal information that tells Word about a possible hyphenation point.</p>
- </remarks>
- </member>
- <member name="F:Aspose.Words.ControlChar.SpaceChar">
- <summary>
- Space character: (char)32.
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.NonBreakingSpaceChar">
- <summary>
- Non-breaking space character: (char)160.
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.DefaultTextInputChar">
- <summary>
- This is the "o" character used as a default value in text input form fields.
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.Cell">
- <summary>
- End of a table cell or end of a table row character: "\x0007" or "\a".
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.Tab">
- <summary>
- Tab character: "\x0009" or "\t".
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.Lf">
- <summary>
- Line feed character: "\x000a" or "\n". Same as <see cref="F:Aspose.Words.ControlChar.LineFeed" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.LineFeed">
- <summary>
- Line feed character: "\x000a" or "\n". Same as <see cref="F:Aspose.Words.ControlChar.Lf" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.LineBreak">
- <summary>
- Line break character: "\x000b" or "\v".
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.PageBreak">
- <summary>
- Page break character: "\x000c" or "\f". Note it has the same value as <see cref="F:Aspose.Words.ControlChar.SectionBreak" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.SectionBreak">
- <summary>
- End of section character: "\x000c" or "\f". Note it has the same value as <see cref="F:Aspose.Words.ControlChar.PageBreak" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.Cr">
- <summary>
- Carriage return character: "\x000d" or "\r". Same as <see cref="F:Aspose.Words.ControlChar.ParagraphBreak" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.ParagraphBreak">
- <summary>
- End of paragraph character: "\x000d" or "\r". Same as <see cref="F:Aspose.Words.ControlChar.Cr" /></summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.ColumnBreak">
- <summary>
- End of column character: "\x000e".
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.CrLf">
- <summary>
- Carriage return followed by line feed character: "\x000d\x000a" or "\r\n".
- Not used as such in Microsoft Word documents, but commonly used in text files for paragraph breaks.
- </summary>
- </member>
- <member name="F:Aspose.Words.ControlChar.NonBreakingSpace">
- <summary>
- Non-breaking space character: "\x00a0".
- </summary>
- </member>
- <member name="T:Aspose.Words.DropCapPosition">
- <summary>
- Specifies the position for a drop cap text.
- </summary>
- </member>
- <member name="F:Aspose.Words.DropCapPosition.None">
- <summary>
- The paragraph does not have a drop cap.
- </summary>
- </member>
- <member name="F:Aspose.Words.DropCapPosition.Normal">
- <summary>
- The drop cap is positioned inside the text margin on the anchor paragraph.
- </summary>
- </member>
- <member name="F:Aspose.Words.DropCapPosition.Margin">
- <summary>
- The drop cap is positioned outside the text margin on the anchor paragraph.
- </summary>
- </member>
- <member name="T:Aspose.Words.Font">
- <summary>
- Contains font attributes (font name, font size, color, and so on) for an object.
- </summary>
- <remarks>
- <p>You do not create instances of the <see cref="T:Aspose.Words.Font" /> class directly. You just use
- <see cref="T:Aspose.Words.Font" /> to access the font properties of the various objects such as <see cref="T:Aspose.Words.Run" />,
- <see cref="T:Aspose.Words.Paragraph" />, <see cref="T:Aspose.Words.Style" />, <see cref="T:Aspose.Words.DocumentBuilder" />.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Font.ClearFormatting">
- <summary>
- Resets to default font formatting.
- </summary>
- <remarks>
- <p>Removes all font formatting specified explicitly on the object from which
- <b>Font</b> was obtained so the font formatting will be inherited from
- the appropriate parent.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Font.HasDmlEffect(Aspose.Words.TextDmlEffect)">
- <summary>
- Checks if particular DrawingML text effect is applied.
- </summary>
- <param name="dmlEffectType">DrawingML text effect type.</param>
- <returns>True if particular DrawingML text effect is applied.</returns>
- </member>
- <member name="P:Aspose.Words.Font.Name">
- <summary>
- Gets or sets the name of the font.
- </summary>
- <remarks>
- <p>When getting, returns <see cref="P:Aspose.Words.Font.NameAscii" />.</p>
- <p>When setting, sets <see cref="P:Aspose.Words.Font.NameAscii" />, <see cref="P:Aspose.Words.Font.NameBi" />, <see cref="P:Aspose.Words.Font.NameFarEast" />
- and <see cref="P:Aspose.Words.Font.NameOther" /> to the specified value.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Font.NameAscii">
- <summary>
- Returns or sets the font used for Latin text (characters with character codes from 0 (zero) through 127).
- </summary>
- <seealso cref="P:Aspose.Words.Font.Name" />
- </member>
- <member name="P:Aspose.Words.Font.NameBi">
- <summary>
- Returns or sets the name of the font in a right-to-left language document.
- </summary>
- <seealso cref="P:Aspose.Words.Font.Name" />
- </member>
- <member name="P:Aspose.Words.Font.NameFarEast">
- <summary>
- Returns or sets an East Asian font name.
- </summary>
- <seealso cref="P:Aspose.Words.Font.Name" />
- </member>
- <member name="P:Aspose.Words.Font.NameOther">
- <summary>
- Returns or sets the font used for characters with character codes from 128 through 255.
- </summary>
- <seealso cref="P:Aspose.Words.Font.Name" />
- </member>
- <member name="P:Aspose.Words.Font.Size">
- <summary>
- Gets or sets the font size in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.SizeBi">
- <summary>
- Gets or sets the font size in points used in a right-to-left document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Bold">
- <summary>
- True if the font is formatted as bold.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.BoldBi">
- <summary>
- True if the right-to-left text is formatted as bold.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Italic">
- <summary>
- True if the font is formatted as italic.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.ItalicBi">
- <summary>
- True if the right-to-left text is formatted as italic.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Color">
- <summary>
- Gets or sets the color of the font.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.AutoColor">
- <summary>
- Returns the present calculated color of the text (black or white) to be used for 'auto color'.
- If the color is not 'auto' then returns <see cref="P:Aspose.Words.Font.Color" />.
- </summary>
- <remarks>
- <p>
- When text has 'automatic color', the actual color of text is calculated automatically
- so that it is readable against the background color. As you change the background color,
- the text color will automatically switch to black or white in MS Word to maximize legibility.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Font.StrikeThrough">
- <summary>
- True if the font is formatted as strikethrough text.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.DoubleStrikeThrough">
- <summary>
- True if the font is formatted as double strikethrough text.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Shadow">
- <summary>
- True if the font is formatted as shadowed.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Outline">
- <summary>
- True if the font is formatted as outline.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Emboss">
- <summary>
- True if the font is formatted as embossed.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Engrave">
- <summary>
- True if the font is formatted as engraved.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Superscript">
- <summary>
- True if the font is formatted as superscript.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Subscript">
- <summary>
- True if the font is formatted as subscript.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.SmallCaps">
- <summary>
- True if the font is formatted as small capital letters.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.AllCaps">
- <summary>
- True if the font is formatted as all capital letters.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Hidden">
- <summary>
- True if the font is formatted as hidden text.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Underline">
- <summary>
- Gets or sets the type of underline applied to the font.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.UnderlineColor">
- <summary>
- Gets or sets the color of the underline applied to the font.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Scaling">
- <summary>
- Gets or sets character width scaling in percent.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Spacing">
- <summary>
- Returns or sets the spacing (in points) between characters .
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.LineSpacing">
- <summary>
- Returns line spacing of this font (in points).
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Position">
- <summary>
- Gets or sets the position of text (in points) relative to the base line.
- A positive number raises the text, and a negative number lowers it.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Kerning">
- <summary>
- Gets or sets the font size at which kerning starts.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.HighlightColor">
- <summary>
- Gets or sets the highlight (marker) color.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.TextEffect">
- <summary>
- Gets or sets the font animation effect.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Bidi">
- <summary>
- Specifies whether the contents of this run shall have right-to-left characteristics.
- </summary>
- <remarks>
- <para>This property, when on, shall not be used with strongly left-to-right text. Any behavior under that condition is unspecified.
- This property, when off, shall not be used with strong right-to-left text. Any behavior under that condition is unspecified.</para>
- <para>When the contents of this run are displayed, all characters shall be treated as complex script characters for formatting
- purposes. This means that <see cref="P:Aspose.Words.Font.BoldBi" />, <see cref="P:Aspose.Words.Font.ItalicBi" />, <see cref="P:Aspose.Words.Font.SizeBi" /> and a corresponding font name
- will be used when rendering this run.</para>
- <para>Also, when the contents of this run are displayed, this property acts as a right-to-left override for characters
- which are classified as "weak types" and "neutral types".</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Font.ComplexScript">
- <summary>
- Specifies whether the contents of this run shall be treated as complex script text regardless
- of their Unicode character values when determining the formatting for this run.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.NoProofing">
- <summary>
- True when the formatted characters are not to be spell checked.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.LocaleId">
- <summary>
- Gets or sets the locale identifier (language) of the formatted characters.
- </summary>
- <remarks>
- For the list of locale identifiers see https://msdn.microsoft.com/en-us/library/cc233965.aspx
- </remarks>
- </member>
- <member name="P:Aspose.Words.Font.LocaleIdBi">
- <summary>
- Gets or sets the locale identifier (language) of the formatted right-to-left characters.
- </summary>
- <remarks>
- For the list of locale identifiers see https://msdn.microsoft.com/en-us/library/cc233965.aspx
- </remarks>
- </member>
- <member name="P:Aspose.Words.Font.LocaleIdFarEast">
- <summary>
- Gets or sets the locale identifier (language) of the formatted Asian characters.
- </summary>
- <remarks>
- For the list of locale identifiers see https://msdn.microsoft.com/en-us/library/cc233965.aspx
- </remarks>
- </member>
- <member name="P:Aspose.Words.Font.Border">
- <summary>
- Returns a Border object that specifies border for the font.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Shading">
- <summary>
- Returns a Shading object that refers to the shading formatting for the font.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.Style">
- <summary>
- Gets or sets the character style applied to this formatting.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.StyleName">
- <summary>
- Gets or sets the name of the character style applied to this formatting.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.StyleIdentifier">
- <summary>
- Gets or sets the locale independent style identifier of the character style applied to this formatting.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.SnapToGrid">
- <summary>
- Specifies whether the current font should use the document grid characters per line settings
- when laying out.
- </summary>
- </member>
- <member name="P:Aspose.Words.Font.EmphasisMark">
- <summary>
- Gets or sets the emphasis mark applied to this formatting.
- </summary>
- </member>
- <member name="T:Aspose.Words.HeightRule">
- <summary>
- Specifies the rule for determining the height of an object.
- </summary>
- </member>
- <member name="F:Aspose.Words.HeightRule.AtLeast">
- <summary>
- The height will be at least the specified height in points. It will grow, if needed,
- to accommodate all text inside an object.
- </summary>
- </member>
- <member name="F:Aspose.Words.HeightRule.Exactly">
- <summary>
- The height is specified exactly in points. Please note that if the text cannot
- fit inside the object of this height, it will appear truncated.
- </summary>
- </member>
- <member name="F:Aspose.Words.HeightRule.Auto">
- <summary>
- The height will grow automatically to accommodate all text inside an object.
- </summary>
- </member>
- <member name="T:Aspose.Words.Inline">
- <summary>
- Base class for inline-level nodes that can have character formatting associated with them, but cannot have child nodes of their own.
- </summary>
- <remarks>
- <p>A class derived from <b>Inline</b> can be a child of <b>Paragraph</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Inline.ParentParagraph">
- <summary>
- Retrieves the parent <see cref="T:Aspose.Words.Paragraph" /> of this node.
- </summary>
- </member>
- <member name="P:Aspose.Words.Inline.Font">
- <summary>
- Provides access to the font formatting of this object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Inline.IsInsertRevision">
- <summary>
- Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Inline.IsDeleteRevision">
- <summary>
- Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Inline.IsMoveFromRevision">
- <summary>
- Returns <b>true</b> if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Inline.IsMoveToRevision">
- <summary>
- Returns <b>true</b> if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Inline.IsFormatRevision">
- <summary>
- Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="T:Aspose.Words.InlineStory">
- <summary>
- Base class for inline-level nodes that can contain paragraphs and tables.
- </summary>
- <remarks>
- <p>
- <b>InlineStory</b> is a container for block-level nodes <see cref="T:Aspose.Words.Paragraph" /> and <see cref="T:Aspose.Words.Tables.Table" />.</p>
- <p>The classes that derive from <b>InlineStory</b> are inline-level nodes that can contain
- their own text (paragraphs and tables). For example, a <b>Comment</b> node contains text of a comment
- and a <b>Footnote</b> contains text of a footnote.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.InlineStory.EnsureMinimum">
- <summary>
- If the last child is not a paragraph, creates and appends one empty paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.InlineStory.StoryType">
- <summary>
- Returns the type of the story.
- </summary>
- </member>
- <member name="P:Aspose.Words.InlineStory.ParentParagraph">
- <summary>
- Retrieves the parent <see cref="T:Aspose.Words.Paragraph" /> of this node.
- </summary>
- </member>
- <member name="P:Aspose.Words.InlineStory.FirstParagraph">
- <summary>
- Gets the first paragraph in the story.
- </summary>
- </member>
- <member name="P:Aspose.Words.InlineStory.LastParagraph">
- <summary>
- Gets the last paragraph in the story.
- </summary>
- </member>
- <member name="P:Aspose.Words.InlineStory.Paragraphs">
- <summary>
- Gets a collection of paragraphs that are immediate children of the story.
- </summary>
- </member>
- <member name="P:Aspose.Words.InlineStory.Tables">
- <summary>
- Gets a collection of tables that are immediate children of the story.
- </summary>
- </member>
- <member name="P:Aspose.Words.InlineStory.IsInsertRevision">
- <summary>
- Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.InlineStory.IsDeleteRevision">
- <summary>
- Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.InlineStory.IsMoveFromRevision">
- <summary>
- Returns <b>true</b> if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.InlineStory.IsMoveToRevision">
- <summary>
- Returns <b>true</b> if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.InlineStory.Font">
- <summary>
- Provides access to the font formatting of the anchor character of this object.
- </summary>
- </member>
- <member name="T:Aspose.Words.LineSpacingRule">
- <summary>
- Specifies line spacing values for a paragraph.
- </summary>
- </member>
- <member name="F:Aspose.Words.LineSpacingRule.AtLeast">
- <summary>
- The line spacing can be greater than or equal to, but never less than,
- the value specified in the <see cref="P:Aspose.Words.ParagraphFormat.LineSpacing" /> property.
- </summary>
- </member>
- <member name="F:Aspose.Words.LineSpacingRule.Exactly">
- <summary>
- The line spacing never changes from the value specified in the
- <see cref="P:Aspose.Words.ParagraphFormat.LineSpacing" /> property,
- even if a larger font is used within the paragraph.
- </summary>
- </member>
- <member name="F:Aspose.Words.LineSpacingRule.Multiple">
- <summary>
- The line spacing is specified in the <see cref="P:Aspose.Words.ParagraphFormat.LineSpacing" />
- property as the number of lines. One line equals 12 points.
- </summary>
- </member>
- <member name="T:Aspose.Words.ListFormat">
- <summary>
- Allows to control what list formatting is applied to a paragraph.
- </summary>
- <remarks>
- <p>A paragraph in a Microsoft Word document can be bulleted or numbered.
- When a paragraph is bulleted or numbered, it is said that list formatting
- is applied to the paragraph.</p>
- <p>You do not create objects of the <see cref="T:Aspose.Words.ListFormat" /> class directly.
- You access <see cref="T:Aspose.Words.ListFormat" /> as a property of another object that can
- have list formatting associated with it. At the moment the objects that can
- have list formatting are: <see cref="T:Aspose.Words.Paragraph" />,
- <see cref="T:Aspose.Words.Style" /> and <see cref="T:Aspose.Words.DocumentBuilder" />.</p>
- <p>
- <see cref="T:Aspose.Words.ListFormat" /> of a <see cref="T:Aspose.Words.Paragraph" /> specifies
- what list formatting and list level is applied to that particular paragraph.</p>
- <p>
- <see cref="T:Aspose.Words.ListFormat" /> of a <see cref="T:Aspose.Words.Style" /> (applicable
- to paragraph styles only) allows to specify what list formatting and list level
- is applied to all paragraphs of that particular style.</p>
- <p>
- <see cref="T:Aspose.Words.ListFormat" /> of a <see cref="T:Aspose.Words.DocumentBuilder" />
- provides access to the list formatting at the current cursor position
- inside the <see cref="T:Aspose.Words.DocumentBuilder" />.</p>
- <p>The list formatting itself is stored inside a <see cref="T:Aspose.Words.Lists.List" />
- object that is stored separately from the paragraphs. The list objects
- are stored inside a <see cref="T:Aspose.Words.Lists.ListCollection" /> collection. There is a single
- <see cref="T:Aspose.Words.Lists.ListCollection" /> collection per <see cref="T:Aspose.Words.Document" />.</p>
- <p>The paragraphs do not physically belong to a list. The paragraphs just
- reference a particular list object via the <see cref="P:Aspose.Words.ListFormat.List" /> property
- and a particular level in the list via the <see cref="P:Aspose.Words.ListFormat.ListLevelNumber" /> property.
- By setting these two properties you control what bullets and numbering is
- applied to a paragraph.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.ListFormat.ApplyBulletDefault">
- <summary>
- Starts a new default bulleted list and applies it to the paragraph.
- </summary>
- <remarks>
- <p>This is a shortcut method that creates a new list using the default bulleted
- template, applies it to the paragraph and selects the 1st list level.</p>
- <seealso cref="P:Aspose.Words.ListFormat.List" />
- <seealso cref="M:Aspose.Words.ListFormat.RemoveNumbers" />
- <seealso cref="P:Aspose.Words.ListFormat.ListLevelNumber" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.ListFormat.ApplyNumberDefault">
- <summary>
- Starts a new default numbered list and applies it to the paragraph.
- </summary>
- <remarks>
- <p>This is a shortcut method that creates a new list using the default numbered
- template, applies it to the paragraph and selects the 1st list level.</p>
- <seealso cref="P:Aspose.Words.ListFormat.List" />
- <seealso cref="M:Aspose.Words.ListFormat.RemoveNumbers" />
- <seealso cref="P:Aspose.Words.ListFormat.ListLevelNumber" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.ListFormat.RemoveNumbers">
- <summary>
- Removes numbers or bullets from the current paragraph and sets list level to zero.
- </summary>
- <remarks>
- <p>Calling this method is equivalent to setting the <see cref="P:Aspose.Words.ListFormat.List" /> property to null.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.ListFormat.ListIndent">
- <summary>
- Increases the list level of the current paragraph by one level.
- </summary>
- <remarks>
- <p>This method changes the list level and applies formatting properties of the new level.</p>
- <p>In Word documents, lists may consist of up to nine levels. List formatting
- for each level specifies what bullet or number is used, left indent, space between
- the bullet and text etc.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.ListFormat.ListOutdent">
- <summary>
- Decreases the list level of the current paragraph by one level.
- </summary>
- <remarks>
- <p>This method changes the list level and applies formatting properties of the new level.</p>
- <p>In Word documents, lists may consist of up to nine levels. List formatting
- for each level specifies what bullet or number is used, left indent, space between
- the bullet and text etc.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.ListFormat.ListLevelNumber">
- <summary>
- Gets or sets the list level number (0 to 8) for the paragraph.
- </summary>
- <remarks>
- <p>In Word documents, lists may consist of 1 or 9 levels, numbered 0 to 8.</p>
- <p>Has effect only when the <see cref="P:Aspose.Words.ListFormat.List" /> property is set to reference a valid list.</p>
- <seealso cref="P:Aspose.Words.ListFormat.List" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.ListFormat.IsListItem">
- <summary>
- True when the paragraph has bulleted or numbered formatting applied to it.
- </summary>
- </member>
- <member name="P:Aspose.Words.ListFormat.List">
- <summary>
- Gets or sets the list this paragraph is a member of.
- </summary>
- <remarks>
- <p>The list that is being assigned to this property must belong to the current document.</p>
- <p>The list that is being assigned to this property must not be a list style definition.</p>
- <p>Setting this property to null removes bullets and numbering from the paragraph
- and sets the list level number to zero. Setting this property to null is equivalent
- to calling <see cref="M:Aspose.Words.ListFormat.RemoveNumbers" />.</p>
- <seealso cref="P:Aspose.Words.ListFormat.ListLevelNumber" />
- <seealso cref="M:Aspose.Words.ListFormat.RemoveNumbers" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.ListFormat.ListLevel">
- <summary>
- Returns the list level formatting plus any formatting overrides applied to the current paragraph.
- </summary>
- </member>
- <member name="T:Aspose.Words.OutlineLevel">
- <summary>
- Specifies the outline level of a paragraph in the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.OutlineLevel.Level1">
- <summary>
- The paragraph is at the outline level 1 (topmost level).
- </summary>
- </member>
- <member name="F:Aspose.Words.OutlineLevel.Level2">
- <summary>
- The paragraph is at the outline level 2.
- </summary>
- </member>
- <member name="F:Aspose.Words.OutlineLevel.Level3">
- <summary>
- The paragraph is at the outline level 3.
- </summary>
- </member>
- <member name="F:Aspose.Words.OutlineLevel.Level4">
- <summary>
- The paragraph is at the outline level 4.
- </summary>
- </member>
- <member name="F:Aspose.Words.OutlineLevel.Level5">
- <summary>
- The paragraph is at the outline level 5.
- </summary>
- </member>
- <member name="F:Aspose.Words.OutlineLevel.Level6">
- <summary>
- The paragraph is at the outline level 6.
- </summary>
- </member>
- <member name="F:Aspose.Words.OutlineLevel.Level7">
- <summary>
- The paragraph is at the outline level 7.
- </summary>
- </member>
- <member name="F:Aspose.Words.OutlineLevel.Level8">
- <summary>
- The paragraph is at the outline level 8.
- </summary>
- </member>
- <member name="F:Aspose.Words.OutlineLevel.Level9">
- <summary>
- The paragraph is at the outline level 9.
- </summary>
- </member>
- <member name="F:Aspose.Words.OutlineLevel.BodyText">
- <summary>
- The paragraph is at the level of the main text.
- </summary>
- </member>
- <member name="T:Aspose.Words.Paragraph">
- <summary>
- Represents a paragraph of text.
- </summary>
- <remarks>
- <p>
- <see cref="T:Aspose.Words.Paragraph" /> is a block-level node and can be a child of classes derived from
- <see cref="T:Aspose.Words.Story" /> or <see cref="T:Aspose.Words.InlineStory" />.</p>
- <p>
- <see cref="T:Aspose.Words.Paragraph" /> can contain any number of inline-level nodes and bookmarks.</p>
- <p>The complete list of child nodes that can occur inside a paragraph consists of
- <see cref="T:Aspose.Words.BookmarkStart" />, <see cref="T:Aspose.Words.BookmarkEnd" />,
- <see cref="T:Aspose.Words.Fields.FieldStart" />, <see cref="T:Aspose.Words.Fields.FieldSeparator" />,
- <see cref="T:Aspose.Words.Fields.FieldEnd" />, <see cref="T:Aspose.Words.Fields.FormField" />,
- <see cref="T:Aspose.Words.Comment" />, <see cref="T:Aspose.Words.Footnote" />,
- <see cref="T:Aspose.Words.Run" />, <see cref="T:Aspose.Words.SpecialChar" />,
- <see cref="T:Aspose.Words.Drawing.Shape" />, <see cref="T:Aspose.Words.Drawing.GroupShape" />,
- <see cref="T:Aspose.Words.Markup.SmartTag" />.</p>
- <p>A valid paragraph in Microsoft Word always ends with a paragraph break character and
- a minimal valid paragraph consists just of a paragraph break. The <b>Paragraph</b>
- class automatically appends the appropriate paragraph break character at the end
- and this character is not part of the child nodes of the <b>Paragraph</b>, therefore
- a <b>Paragraph</b> can be empty.</p>
- <p>Do not include the end of paragraph <see cref="F:Aspose.Words.ControlChar.ParagraphBreak">ControlChar.ParagraphBreak</see>
- or end of cell <see cref="F:Aspose.Words.ControlChar.Cell">ControlChar.Cell</see> characters inside the text of
- the paragraph as it might make the paragraph invalid when the document is opened in Microsoft Word.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Paragraph.#ctor(Aspose.Words.DocumentBase)">
- <summary>
- Initializes a new instance of the <b>Paragraph</b> class.
- </summary>
- <remarks>
- <p>When <b>Paragraph</b> is created, it belongs to the specified document, but is not
- yet part of the document and <b>ParentNode</b> is null.</p>
- <p>To append <b>Paragraph</b> to the document use InsertAfter or InsertBefore
- on the story where you want the paragraph inserted.</p>
- </remarks>
- <param name="doc">The owner document.</param>
- </member>
- <member name="M:Aspose.Words.Paragraph.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls DocumentVisitor.VisitParagraphStart, then calls Accept for all child nodes
- of the paragraph and calls DocumentVisitor.VisitParagraphEnd at the end.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Paragraph.GetText">
- <summary>
- Gets the text of this paragraph including the end of paragraph character.
- </summary>
- <remarks>
- <p>The text of all child nodes is concatenated and the end of paragraph character is appended as follows:</p>
- <list type="bullet">
- <item>If the paragraph is the last paragraph of <see cref="T:Aspose.Words.Body" />, then
- <see cref="F:Aspose.Words.ControlChar.SectionBreak">ControlChar.SectionBreak</see> (\x000c) is appended.</item>
- <item>If the paragraph is the last paragraph of <see cref="T:Aspose.Words.Tables.Cell" />, then
- <see cref="F:Aspose.Words.ControlChar.Cell">ControlChar.Cell</see> (\x0007) is appended.</item>
- <item>For all other paragraphs
- <see cref="F:Aspose.Words.ControlChar.ParagraphBreak">ControlChar.ParagraphBreak</see> (\r) is appended.</item>
- </list>
- <p>The returned string includes all control and special characters as described in <see cref="T:Aspose.Words.ControlChar" />.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Paragraph.GetEffectiveTabStops">
- <summary>
- Returns array of all tab stops applied to this paragraph, including applied indirectly by styles or lists.
- </summary>
- </member>
- <member name="M:Aspose.Words.Paragraph.JoinRunsWithSameFormatting">
- <summary>
- Joins runs with the same formatting in the paragraph.
- </summary>
- <returns>Number of joins performed. When <b>N</b> adjacent runs are being joined they count as <b>N - 1</b> joins.</returns>
- </member>
- <member name="M:Aspose.Words.Paragraph.JoinRunsWithSameFormatting(System.Text.StringBuilder)">
- <summary>
- Joins runs with same formatting in the paragraph.
- StringBuilder is passed to avoid its recreation since we process many paragraphs.
- Someday we can make override without parameters public and retain this one internal.
- </summary>
- <param name="sb">Utility StringBuilder</param>
- <returns>Number of joins performed</returns>
- </member>
- <member name="M:Aspose.Words.Paragraph.AppendField(Aspose.Words.Fields.FieldType,System.Boolean)">
- <overloads>Appends a Word field to this paragraph.</overloads>
- <summary>
- Appends a field to this paragraph.
- </summary>
- <param name="fieldType">The type of the field to append.</param>
- <param name="updateField">Specifies whether to update the field immediately.</param>
- <returns>A <see cref="T:Aspose.Words.Fields.Field" /> object that represents the appended field.</returns>
- </member>
- <member name="M:Aspose.Words.Paragraph.AppendField(System.String)">
- <overloads>Appends a Word field to this paragraph.</overloads>
- <summary>
- Appends a field to this paragraph.
- </summary>
- <param name="fieldCode">The field code to append (without curly braces).</param>
- <returns>A <see cref="T:Aspose.Words.Fields.Field" /> object that represents the appended field.</returns>
- </member>
- <member name="M:Aspose.Words.Paragraph.AppendField(System.String,System.String)">
- <overloads>Appends a Word field to this paragraph.</overloads>
- <summary>
- Appends a field to this paragraph.
- </summary>
- <param name="fieldCode">The field code to append (without curly braces).</param>
- <param name="fieldValue">The field value to append. Pass null for fields that do not have a value.</param>
- <returns>A <see cref="T:Aspose.Words.Fields.Field" /> object that represents the appended field.</returns>
- </member>
- <member name="M:Aspose.Words.Paragraph.InsertField(Aspose.Words.Fields.FieldType,System.Boolean,Aspose.Words.Node,System.Boolean)">
- <overloads>Inserts a Word field into this paragraph.</overloads>
- <summary>
- Inserts a field into this paragraph.
- </summary>
- <param name="fieldType">The type of the field to insert.</param>
- <param name="updateField">Specifies whether to update the field immediately.</param>
- <param name="refNode">Reference node inside this paragraph (if refNode is null, then appends to the end of the paragraph).</param>
- <param name="isAfter">Whether to insert the field after or before reference node.</param>
- <returns>A <see cref="T:Aspose.Words.Fields.Field" /> object that represents the inserted field.</returns>
- </member>
- <member name="M:Aspose.Words.Paragraph.InsertField(System.String,Aspose.Words.Node,System.Boolean)">
- <overloads>Inserts a Word field into this paragraph.</overloads>
- <summary>
- Inserts a field into this paragraph.
- </summary>
- <param name="fieldCode">The field code to insert (without curly braces).</param>
- <param name="refNode">Reference node inside this paragraph (if refNode is null, then appends to the end of the paragraph).</param>
- <param name="isAfter">Whether to insert the field after or before reference node.</param>
- <returns>A <see cref="T:Aspose.Words.Fields.Field" /> object that represents the inserted field.</returns>
- </member>
- <member name="M:Aspose.Words.Paragraph.InsertField(System.String,System.String,Aspose.Words.Node,System.Boolean)">
- <overloads>Inserts a Word field into this paragraph.</overloads>
- <summary>
- Inserts a field into this paragraph.
- </summary>
- <param name="fieldCode">The field code to insert (without curly braces).</param>
- <param name="fieldValue">The field value to insert. Pass null for fields that do not have a value.</param>
- <param name="refNode">Reference node inside this paragraph (if refNode is null, then appends to the end of the paragraph).</param>
- <param name="isAfter">Whether to insert the field after or before reference node.</param>
- <returns>A <see cref="T:Aspose.Words.Fields.Field" /> object that represents the inserted field.</returns>
- </member>
- <member name="P:Aspose.Words.Paragraph.NodeType">
- <summary>
- Returns <b>NodeType.Paragraph</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.ParentStory">
- <summary>
- Retrieves the parent section-level story that can be <see cref="T:Aspose.Words.Body" /> or <see cref="T:Aspose.Words.HeaderFooter" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.ParentSection">
- <summary>
- Retrieves the parent <see cref="T:Aspose.Words.Section" /> of the paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.IsInCell">
- <summary>
- True if this paragraph is an immediate child of <see cref="T:Aspose.Words.Tables.Cell" />; false otherwise.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.IsEndOfCell">
- <summary>
- True if this paragraph is the last paragraph in a <see cref="T:Aspose.Words.Tables.Cell" />; false otherwise.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.BreakIsStyleSeparator">
- <summary>
- True if this paragraph break is a Style Separator. A style separator allows one
- paragraph to consist of parts that have different paragraph styles.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.IsEndOfSection">
- <summary>
- True if this paragraph is the last paragraph in the <b>Body</b> (main text story) of a <b>Section</b>; false otherwise.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.IsEndOfHeaderFooter">
- <summary>
- True if this paragraph is the last paragraph in the <b>HeaderFooter</b> (main text story) of a <b>Section</b>; false otherwise.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.IsEndOfDocument">
- <summary>
- True if this paragraph is the last paragraph in the last section of the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.ParagraphFormat">
- <summary>
- Provides access to the paragraph formatting properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.ListFormat">
- <summary>
- Provides access to the list formatting properties of the paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.FrameFormat">
- <summary>
- Provides access to the paragraph formatting properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.ListLabel">
- <summary>
- Gets a <see cref="P:Aspose.Words.Paragraph.ListLabel" /> object that provides access to list numbering value and formatting
- for this paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.Runs">
- <summary>
- Provides access to the typed collection of pieces of text inside the paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.ParagraphBreakFont">
- <summary>
- Provides access to the font formatting of the paragraph break character.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.IsInsertRevision">
- <summary>
- Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.IsDeleteRevision">
- <summary>
- Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.IsMoveFromRevision">
- <summary>
- Returns <b>true</b> if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.IsMoveToRevision">
- <summary>
- Returns <b>true</b> if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.IsFormatRevision">
- <summary>
- Returns true if formatting of the object was changed in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Paragraph.IsListItem">
- <summary>
- True when the paragraph is an item in a bulleted or numbered list in original revision.
- </summary>
- </member>
- <member name="T:Aspose.Words.ParagraphAlignment">
- <summary>
- Specifies text alignment in a paragraph.
- </summary>
- </member>
- <member name="F:Aspose.Words.ParagraphAlignment.Left">
- <summary>
- Text is aligned to the left.
- </summary>
- </member>
- <member name="F:Aspose.Words.ParagraphAlignment.Center">
- <summary>
- Text is centered horizontally.
- </summary>
- </member>
- <member name="F:Aspose.Words.ParagraphAlignment.Right">
- <summary>
- Text is aligned to the right.
- </summary>
- </member>
- <member name="F:Aspose.Words.ParagraphAlignment.Justify">
- <summary>
- Text is aligned to both left and right.
- </summary>
- </member>
- <member name="F:Aspose.Words.ParagraphAlignment.Distributed">
- <summary>
- Text is evenly distributed.
- </summary>
- </member>
- <member name="F:Aspose.Words.ParagraphAlignment.ArabicMediumKashida">
- <summary>
- Arabic only. Kashida length for text is extended to a medium length determined by the consumer.
- </summary>
- </member>
- <member name="F:Aspose.Words.ParagraphAlignment.ArabicHighKashida">
- <summary>
- Arabic only. Kashida length for text is extended to its widest possible length.
- </summary>
- </member>
- <member name="F:Aspose.Words.ParagraphAlignment.ArabicLowKashida">
- <summary>
- Arabic only. Kashida length for text is extended to a slightly longer length.
- </summary>
- </member>
- <member name="F:Aspose.Words.ParagraphAlignment.ThaiDistributed">
- <summary>
- Thai only. Text is justified with an optimization for Thai.
- </summary>
- </member>
- <member name="T:Aspose.Words.ParagraphFormat">
- <summary>
- Represents all the formatting for a paragraph.
- </summary>
- </member>
- <member name="M:Aspose.Words.ParagraphFormat.ClearFormatting">
- <summary>
- Resets to default paragraph formatting.
- </summary>
- <remarks>
- Default paragraph formatting is Normal style, left aligned, no indentation,
- no spacing, no borders and no shading.
- </remarks>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.Alignment">
- <summary>
- Gets or sets text alignment for the paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.NoSpaceBetweenParagraphsOfSameStyle">
- <summary>
- When true, <see cref="P:Aspose.Words.ParagraphFormat.SpaceBefore" /> and <see cref="P:Aspose.Words.ParagraphFormat.SpaceAfter" /> will be ignored
- between the paragraphs of the same style.
- </summary>
- <remarks>
- <p>This setting only takes affect when applied to a paragraph style. If applied to
- a paragraph directly, it has no effect.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.KeepTogether">
- <summary>
- True if all lines in the paragraph are to remain on the same page.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.KeepWithNext">
- <summary>
- True if the paragraph is to remains on the same page as the paragraph that follows it.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.PageBreakBefore">
- <summary>
- True if a page break is forced before the paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.SuppressLineNumbers">
- <summary>
- Specifies whether the current paragraph's lines should be exempted from line numbering
- which is applied in the parent section.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.SuppressAutoHyphens">
- <summary>
- Specifies whether the current paragraph should be exempted from any hyphenation which
- is applied in the document settings.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.WidowControl">
- <summary>
- True if the first and last lines in the paragraph are to remain on the same page as the rest of the paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.AddSpaceBetweenFarEastAndAlpha">
- <summary>
- Gets or sets a flag indicating whether inter-character spacing is automatically adjusted between regions
- of Latin text and regions of East Asian text in the current paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.AddSpaceBetweenFarEastAndDigit">
- <summary>
- Gets or sets a flag indicating whether inter-character spacing is automatically adjusted between regions
- of numbers and regions of East Asian text in the current paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.FarEastLineBreakControl">
- <summary>
- Gets or sets a flag indicating whether East Asian line-breaking rules are applied to the current paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.WordWrap">
- <summary>
- If this property is <b>false</b>, Latin text in the middle of a word can be wrapped for
- the current paragraph. Otherwise Latin text is wrapped by whole words.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.HangingPunctuation">
- <summary>
- Gets or sets a flag indicating whether hanging punctuation is enabled for the current paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.Bidi">
- <summary>
- Gets or sets whether this is a right-to-left paragraph.
- </summary>
- <remarks>
- <p>When true, the runs and other inline objects in this paragraph
- are laid out right to left.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.LeftIndent">
- <summary>
- Gets or sets the value (in points) that represents the left indent for paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.CharacterUnitLeftIndent">
- <summary>
- Gets or sets the left indent value (in characters) for the specified paragraphs.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.RightIndent">
- <summary>
- Gets or sets the value (in points) that represents the right indent for paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.CharacterUnitRightIndent">
- <summary>
- Gets or sets the right indent value (in characters) for the specified paragraphs.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.FirstLineIndent">
- <summary>
- Gets or sets the value (in points) for a first line or hanging indent.
- <p>Use positive values to set the first-line indent, and negative values to set the hanging indent.</p></summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.CharacterUnitFirstLineIndent">
- <summary>
- Gets or sets the value (in characters) for the first-line or hanging indent.
- <p>Use positive values to set the first-line indent, and negative values to set the hanging indent.</p></summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.SpaceBeforeAuto">
- <summary>
- True if the amount of spacing before the paragraph is set automatically.
- </summary>
- <remarks>
- <p>When set to true, overrides the effect of <see cref="P:Aspose.Words.ParagraphFormat.SpaceBefore" />.</p>
- </remarks>
- <remarks>
- <p>When you set paragraph Space Before and Space After to Auto,
- Microsoft Word adds 14 points spacing between paragraphs automatically
- according to the following rules:</p>
- <list type="bullet">
- <item>Normally, spacing is added after all paragraphs.</item>
- <item>In a bulleted or numbered list, spacing is added only after the last item in the list.
- Spacing is not added between the list items.</item>
- <item>In a nested bulleted or numbered list spacing is not added.</item>
- <item>Spacing is normally added after a table.</item>
- <item>Spacing is not added after a table if it is the last block in a table cell.</item>
- <item>Spacing is not added after the last paragraph in a table cell.</item>
- </list>
- </remarks>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.SpaceAfterAuto">
- <summary>
- True if the amount of spacing after the paragraph is set automatically.
- </summary>
- <remarks>
- <p>When set to true, overrides the effect of <see cref="P:Aspose.Words.ParagraphFormat.SpaceAfter" />.</p>
- </remarks>
- <remarks>
- <p>When you set paragraph Space Before and Space After to Auto,
- Microsoft Word adds 14 points spacing between paragraphs automatically
- according to the following rules:</p>
- <list type="bullet">
- <item>Normally, spacing is added after all paragraphs.</item>
- <item>In a bulleted or numbered list, spacing is added only after the last item in the list.
- Spacing is not added between the list items.</item>
- <item>In a nested bulleted or numbered list spacing is not added.</item>
- <item>Spacing is normally added after a table.</item>
- <item>Spacing is not added after a table if it is the last block in a table cell.</item>
- <item>Spacing is not added after the last paragraph in a table cell.</item>
- </list>
- </remarks>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.SpaceBefore">
- <summary>
- Gets or sets the amount of spacing (in points) before the paragraph.
- </summary>
- <remarks>
- <p>Has no effect when <see cref="P:Aspose.Words.ParagraphFormat.SpaceBeforeAuto" /> is true.</p>
- <p>Valid values range from 0 to 1584 inclusive.</p>
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Throws when argument was out of the range of valid values.
- </exception>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.LineUnitBefore">
- <summary>
- Gets or sets the amount of spacing (in gridlines) before the paragraphs.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.SpaceAfter">
- <summary>
- Gets or sets the amount of spacing (in points) after the paragraph.
- </summary>
- <remarks>
- <p>Has no effect when <see cref="P:Aspose.Words.ParagraphFormat.SpaceAfterAuto" /> is true.</p>
- <p>Valid values range from 0 to 1584 inclusive.</p>
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Throws when argument was out of the range of valid values.
- </exception>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.LineUnitAfter">
- <summary>
- Gets or sets the amount of spacing (in gridlines) after the paragraphs.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.LineSpacingRule">
- <summary>
- Gets or sets the line spacing for the paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.LineSpacing">
- <summary>
- Gets or sets the line spacing (in points) for the paragraph.
- </summary>
- <remarks>
- <p>When LineSpacingRule property is set to AtLeast, the line spacing can be greater than or equal to,
- but never less than the specified LineSpacing value.</p>
- <p>When LineSpacingRule property is set to Exactly, the line spacing never changes from
- the specified LineSpacing value, even if a larger font is used within the paragraph.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.IsHeading">
- <summary>
- True when the paragraph style is one of the built-in Heading styles.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.IsListItem">
- <summary>
- True when the paragraph is an item in a bulleted or numbered list.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.OutlineLevel">
- <summary>
- Specifies the outline level of the paragraph in the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.LinesToDrop">
- <summary>
- Gets or sets the number of lines of the paragraph text used to calculate the drop cap height.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.DropCapPosition">
- <summary>
- Gets or sets the position for a drop cap text.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.Shading">
- <summary>
- Returns a Shading object that refers to the shading formatting for the paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.Borders">
- <summary>
- Gets collection of borders of the paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.Style">
- <summary>
- Gets or sets the paragraph style applied to this formatting.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.StyleName">
- <summary>
- Gets or sets the name of the paragraph style applied to this formatting.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.StyleIdentifier">
- <summary>
- Gets or sets the locale independent style identifier of the paragraph style applied to this formatting.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.SnapToGrid">
- <summary>
- Specifies whether the current paragraph should use the document grid lines per page settings
- when laying out the contents in the paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.ParagraphFormat.TabStops">
- <summary>
- Gets the collection of custom tab stops defined for this object.
- </summary>
- </member>
- <member name="T:Aspose.Words.ParagraphCollection">
- <summary>
- Provides typed access to a collection of <see cref="T:Aspose.Words.Paragraph" /> nodes.
- </summary>
- </member>
- <member name="M:Aspose.Words.ParagraphCollection.ToArray">
- <summary>
- Copies all paragraphs from the collection to a new array of paragraphs.
- </summary>
- <returns>An array of paragraphs.</returns>
- </member>
- <member name="P:Aspose.Words.ParagraphCollection.Item(System.Int32)">
- <summary>
- Retrieves a <b>Paragraph</b> at the given index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the collection.</param>
- </member>
- <member name="T:Aspose.Words.Range">
- <summary>
- Represents a contiguous area in a document.
- </summary>
- <remarks>
- <p>The document is represented by a tree of nodes and the nodes provide operations
- to work with the tree, but some operations are easier to perform if the document
- is treated as a contiguous sequence of text.</p>
- <p>
- <b>Range</b> is a "facade" interface that provide methods that treat the document
- or portions of the document as "flat" text regardless of the fact that the document
- nodes are stored in a tree-like object model.</p>
- <p>
- <b>Range</b> does not contain any text or nodes, it is merely a view or "window"
- over a fragment of a document.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Range.Delete">
- <summary>
- Deletes all characters of the range.
- </summary>
- </member>
- <member name="M:Aspose.Words.Range.Replace(System.String,System.String)">
- <summary>
- Replaces all occurrences of a character pattern specified by a regular expression with another string.
- </summary>
- <remarks>
- <p>Used case-insensitive comparison.</p>
- <p>Replaces the whole match captured by the regular expression.</p>
- <p>Method is able to process breaks in both pattern and replacement strings.</p>
- You should use special meta-characters if you need to work with breaks:
- <list type="bullet"><item><b>&p</b> - paragraph break</item><item><b>&b</b> - section break</item><item><b>&m</b> - page break</item><item><b>&l</b> - manual line break</item></list>
- Use method <see cref="M:Aspose.Words.Range.Replace(System.String,System.String,Aspose.Words.Replacing.FindReplaceOptions)" /> to have more flexible customization.
- </remarks>
- <param name="pattern">A string to be replaced.</param>
- <param name="replacement">A string to replace all occurrences of pattern.</param>
- <returns>The number of replacements made.</returns>
- <example>
- <code>
- Document doc = new Document();
- DocumentBuilder builder = new DocumentBuilder(doc);
- builder.Writeln("Numbers 1, 2, 3");
-
- // Inserts paragraph break after Numbers.
- doc.Range.Replace("Numbers", "Numbers&p", new FindReplaceOptions());
- </code>
- </example>
- </member>
- <member name="M:Aspose.Words.Range.Replace(System.Text.RegularExpressions.Regex,System.String)">
- <summary>
- Replaces all occurrences of a character pattern specified by a regular expression with another string.
- </summary>
- <remarks>
- <p>Replaces the whole match captured by the regular expression.</p>
- <p>Method is able to process breaks in both pattern and replacement strings.</p>
- You should use special meta-characters if you need to work with breaks:
- <list type="bullet"><item><b>&p</b> - paragraph break</item><item><b>&b</b> - section break</item><item><b>&m</b> - page break</item><item><b>&l</b> - manual line break</item></list>
- Use method <see cref="M:Aspose.Words.Range.Replace(System.Text.RegularExpressions.Regex,System.String,Aspose.Words.Replacing.FindReplaceOptions)" /> to have more flexible customization.
- </remarks>
- <param name="pattern">A regular expression pattern used to find matches.</param>
- <param name="replacement">A string to replace all occurrences of pattern.</param>
- <returns>The number of replacements made.</returns>
- <example>
- <code>
- Document doc = new Document();
- DocumentBuilder builder = new DocumentBuilder(doc);
- builder.Writeln("a1, b2, c3");
-
- // Replaces each number with paragraph break.
- doc.Range.Replace(new Regex(@"\d+"), "&p");
- </code>
- </example>
- </member>
- <member name="M:Aspose.Words.Range.Replace(System.String,System.String,Aspose.Words.Replacing.FindReplaceOptions)">
- <summary>
- Replaces all occurrences of a character pattern specified by a regular expression with another string.
- </summary>
- <remarks>
- <p>Replaces the whole match captured by the regular expression.</p>
- <p>Method is able to process breaks in both pattern and replacement strings.</p>
- You should use special meta-characters if you need to work with breaks:
- <list type="bullet"><item><b>&p</b> - paragraph break</item><item><b>&b</b> - section break</item><item><b>&m</b> - page break</item><item><b>&l</b> - manual line break</item><item><b>&&</b> - & character</item></list></remarks>
- <param name="pattern">A string to be replaced.</param>
- <param name="replacement">A string to replace all occurrences of pattern.</param>
- <param name="options">
- <see cref="T:Aspose.Words.Replacing.FindReplaceOptions" /> object to specify additional options.</param>
- <returns>The number of replacements made.</returns>
- <example>
- <code>
- Document doc = new Document();
- DocumentBuilder builder = new DocumentBuilder(doc);
- builder.Writeln("Numbers 1, 2, 3");
-
- // Inserts paragraph break after Numbers.
- doc.Range.Replace("Numbers", "Numbers&p", new FindReplaceOptions());
- </code>
- </example>
- </member>
- <member name="M:Aspose.Words.Range.Replace(System.Text.RegularExpressions.Regex,System.String,Aspose.Words.Replacing.FindReplaceOptions)">
- <summary>
- Replaces all occurrences of a character pattern specified by a regular expression with another string.
- </summary>
- <remarks>
- <p>Replaces the whole match captured by the regular expression.</p>
- <p>Method is able to process breaks in both pattern and replacement strings.</p>
- You should use special meta-characters if you need to work with breaks:
- <list type="bullet"><item><b>&p</b> - paragraph break</item><item><b>&b</b> - section break</item><item><b>&m</b> - page break</item><item><b>&l</b> - manual line break</item><item><b>&&</b> - & character</item></list></remarks>
- <param name="pattern">A regular expression pattern used to find matches.</param>
- <param name="replacement">A string to replace all occurrences of pattern.</param>
- <param name="options">
- <see cref="T:Aspose.Words.Replacing.FindReplaceOptions" /> object to specify additional options.</param>
- <returns>The number of replacements made.</returns>
- <example>
- <code>
- Document doc = new Document();
- DocumentBuilder builder = new DocumentBuilder(doc);
- builder.Writeln("a1, b2, c3");
-
- // Replaces each number with paragraph break.
- doc.Range.Replace(new Regex(@"\d+"), "&p", new FindReplaceOptions());
- </code>
- </example>
- </member>
- <member name="M:Aspose.Words.Range.UpdateFields">
- <summary>
- Updates the values of document fields in this range.
- </summary>
- <remarks>
- <para>When you open, modify and then save a document, Aspose.Words does not update fields automatically, it keeps them intact.
- Therefore, you would usually want to call this method before saving if you have modified the document
- programmatically and want to make sure the proper (calculated) field values appear in the saved document.</para>
- <para>There is no need to update fields after executing a mail merge because mail merge is a kind of field update
- and automatically updates all fields in the document.</para>
- <p>This method does not update all field types. For the detailed list of supported field types, see the Programmers Guide.</p>
- <para>This method does not update fields that are related to the page layout algorithms (e.g. PAGE, PAGES, PAGEREF).
- The page layout-related fields are updated when you render a document or call <see cref="M:Aspose.Words.Document.UpdatePageLayout" />.</para>
- <para>To update fields in the whole document use <see cref="M:Aspose.Words.Document.UpdateFields" />.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Range.UnlinkFields">
- <summary>
- Unlinks fields in this range.
- </summary>
- <remarks>
- <para>Replaces all the fields in this range with their most recent results.</para>
- <para>To unlink fields in the whole document use <see cref="M:Aspose.Words.Range.UnlinkFields" />.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Range.NormalizeFieldTypes">
- <summary>
- Changes field type values <see cref="P:Aspose.Words.Fields.FieldChar.FieldType" /> of <see cref="T:Aspose.Words.Fields.FieldStart" />, <see cref="T:Aspose.Words.Fields.FieldSeparator" />, <see cref="T:Aspose.Words.Fields.FieldEnd" />
- in this range so that they correspond to the field types contained in the field codes.
- </summary>
- <remarks>
- <para>Use this method after document changes that affect field types.</para>
- <para>To change field type values in the whole document use <see cref="M:Aspose.Words.Document.NormalizeFieldTypes" />.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Range.ToDocument">
- <summary>
- Constructs a new fully formed document that contains the range.
- </summary>
- </member>
- <member name="P:Aspose.Words.Range.Text">
- <summary>
- Gets the text of the range.
- </summary>
- <remarks>
- <p>The returned string includes all control and special characters as described in <see cref="T:Aspose.Words.ControlChar" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Range.FormFields">
- <summary>
- Returns a <see cref="P:Aspose.Words.Range.FormFields" /> collection that represents all form fields in the range.
- </summary>
- </member>
- <member name="P:Aspose.Words.Range.Bookmarks">
- <summary>
- Returns a <see cref="P:Aspose.Words.Range.Bookmarks" /> collection that represents all bookmarks in the range.
- </summary>
- </member>
- <member name="P:Aspose.Words.Range.Fields">
- <summary>
- Returns a <see cref="P:Aspose.Words.Range.Fields" /> collection that represents all fields in the range.
- </summary>
- </member>
- <member name="T:Aspose.Words.Run">
- <summary>
- Represents a run of characters with the same font formatting.
- </summary>
- <remarks>
- <p>All text of the document is stored in runs of text.</p>
- <p>
- <b>Run</b> can only be a child of <b>Paragraph</b> or inline <b>StructuredDocumentTag</b>.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Run.#ctor(Aspose.Words.DocumentBase)">
- <summary>
- Initializes a new instance of the <b>Run</b> class.
- </summary>
- <remarks>
- <p>When <b>Run</b> is created, it belongs to the specified document, but is not
- yet part of the document and <b>ParentNode</b> is null.</p>
- <p>To append <b>Run</b> to the document use InsertAfter or InsertBefore
- on the paragraph where you want the run inserted.</p>
- </remarks>
- <param name="doc">The owner document.</param>
- </member>
- <member name="M:Aspose.Words.Run.#ctor(Aspose.Words.DocumentBase,System.String)">
- <summary>
- Initializes a new instance of the <b>Run</b> class.
- </summary>
- <remarks>
- <p>When <b>Run</b> is created, it belongs to the specified document, but is not
- yet part of the document and <b>ParentNode</b> is null.</p>
- <p>To append <b>Run</b> to the document use InsertAfter or InsertBefore
- on the paragraph where you want the run inserted.</p>
- </remarks>
- <param name="doc">The owner document.</param>
- <param name="text">The text of the run.</param>
- </member>
- <member name="M:Aspose.Words.Run.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Calls DocumentVisitor.VisitRun.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the node.</param>
- <returns>False if the visitor requested the enumeration to stop.</returns>
- </member>
- <member name="M:Aspose.Words.Run.GetText">
- <summary>
- Gets the text of the run.
- </summary>
- <returns>The text of the run.</returns>
- </member>
- <member name="P:Aspose.Words.Run.NodeType">
- <summary>
- Returns <b>NodeType.Run</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Run.Text">
- <summary>
- Gets or sets the text of the run.
- </summary>
- </member>
- <member name="T:Aspose.Words.RunCollection">
- <summary>
- Provides typed access to a collection of <see cref="T:Aspose.Words.Run" /> nodes.
- </summary>
- </member>
- <member name="M:Aspose.Words.RunCollection.ToArray">
- <summary>
- Copies all runs from the collection to a new array of runs.
- </summary>
- <returns>An array of runs.</returns>
- </member>
- <member name="P:Aspose.Words.RunCollection.Item(System.Int32)">
- <summary>
- Retrieves a <b>Run</b> at the given index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the collection.</param>
- </member>
- <member name="T:Aspose.Words.SpecialChar">
- <summary>
- Base class for special characters in the document.
- </summary>
- <remarks>
- <p>A Microsoft Word document can include a number of special characters
- that represent fields, form fields, shapes, OLE objects, footnotes etc. For the list
- of special characters see <see cref="T:Aspose.Words.ControlChar" />.</p>
- <p>
- <b>SpecialChar</b> is an inline-node and can only be a child of <b>Paragraph</b>.</p>
- <p>
- <b>SpecialChar</b> char is used as a base class for more specific classes
- that represent special characters that Aspose.Words provides programmatic access for.
- The <b>SpecialChar</b> class is also used itself to represent special character for which
- Aspose.Words does not provide detailed programmatic access.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.SpecialChar.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Calls DocumentVisitor.VisitSpecialChar.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the node.</param>
- <returns>False if the visitor requested the enumeration to stop.</returns>
- </member>
- <member name="M:Aspose.Words.SpecialChar.GetText">
- <summary>
- Gets the special character that this node represents.
- </summary>
- <returns>The string that contains the character that this node represents.</returns>
- </member>
- <member name="P:Aspose.Words.SpecialChar.NodeType">
- <summary>
- Returns <b>NodeType.SpecialChar</b>.
- </summary>
- </member>
- <member name="T:Aspose.Words.TabAlignment">
- <summary>
- Specifies the alignment/type of a tab stop.
- </summary>
- </member>
- <member name="F:Aspose.Words.TabAlignment.Left">
- <summary>
- Left-aligns the text after the tab stop.
- </summary>
- </member>
- <member name="F:Aspose.Words.TabAlignment.Center">
- <summary>
- Centers the text around the tab stop.
- </summary>
- </member>
- <member name="F:Aspose.Words.TabAlignment.Right">
- <summary>
- Right-aligns the text at the tab stop.
- </summary>
- </member>
- <member name="F:Aspose.Words.TabAlignment.Decimal">
- <summary>
- Aligns the text at the decimal dot.
- </summary>
- </member>
- <member name="F:Aspose.Words.TabAlignment.Bar">
- <summary>
- Draws a vertical bar at the tab stop position.
- </summary>
- </member>
- <member name="F:Aspose.Words.TabAlignment.List">
- <summary>
- The tab is a delimiter between the number/bullet and text in a list item.
- </summary>
- </member>
- <member name="F:Aspose.Words.TabAlignment.Clear">
- <summary>
- Clears any tab stop in this position.
- </summary>
- </member>
- <member name="T:Aspose.Words.TabLeader">
- <summary>
- Specifies the type of the leader line displayed under the tab character.
- </summary>
- </member>
- <member name="F:Aspose.Words.TabLeader.None">
- <summary>
- No leader line is displayed.
- </summary>
- </member>
- <member name="F:Aspose.Words.TabLeader.Dots">
- <summary>
- The leader line is made up from dots.
- </summary>
- </member>
- <member name="F:Aspose.Words.TabLeader.Dashes">
- <summary>
- The leader line is made up from dashes.
- </summary>
- </member>
- <member name="F:Aspose.Words.TabLeader.Line">
- <summary>
- The leader line is a single line.
- </summary>
- </member>
- <member name="F:Aspose.Words.TabLeader.Heavy">
- <summary>
- The leader line is a single thick line.
- </summary>
- </member>
- <member name="F:Aspose.Words.TabLeader.MiddleDot">
- <summary>
- The leader line is made up from middle-dots.
- </summary>
- </member>
- <member name="T:Aspose.Words.TabStop">
- <summary>
- Represents a single custom tab stop. The <b>TabStop</b> object is a member of the
- <see cref="T:Aspose.Words.TabStopCollection" /> collection.
- </summary>
- <remarks>
- <p>Normally, a tab stop specifies a position where a tab stop exists. But because
- tab stops can be inherited from parent styles, it might be needed for the child object
- to define explicitly that there is no tab stop at a given position. To clear
- an inherited tab stop at a given position, create a <b>TabStop</b> object and set
- <see cref="P:Aspose.Words.TabStop.Alignment" /> to <c>TabAlignment.Clear</c>.</p>
- <p>For more information see <see cref="T:Aspose.Words.TabStopCollection" />.</p>
- <seealso cref="T:Aspose.Words.ParagraphFormat" />
- <seealso cref="T:Aspose.Words.TabStopCollection" />
- <seealso cref="P:Aspose.Words.Document.DefaultTabStop" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.TabStop.#ctor">
- <summary>
- Ctor.
- </summary>
- </member>
- <member name="M:Aspose.Words.TabStop.#ctor(System.Double)">
- <summary>
- Initializes a new instance of this class.
- </summary>
- </member>
- <member name="M:Aspose.Words.TabStop.#ctor(System.Double,Aspose.Words.TabAlignment,Aspose.Words.TabLeader)">
- <summary>
- Initializes a new instance of this class.
- </summary>
- <param name="position">The position of the tab stop in points.</param>
- <param name="alignment">A <see cref="T:Aspose.Words.TabAlignment" /> value that
- specifies the alignment of text at this tab stop.</param>
- <param name="leader">A <see cref="T:Aspose.Words.TabLeader" /> value that specifies
- the type of the leader line displayed under the tab character.</param>
- </member>
- <member name="M:Aspose.Words.TabStop.#ctor(System.Int32,Aspose.Words.TabAlignment,Aspose.Words.TabLeader)">
- <summary>
- Ctor.
- </summary>
- </member>
- <member name="M:Aspose.Words.TabStop.Equals(Aspose.Words.TabStop)">
- <summary>
- Compares with the specified TabStop.
- </summary>
- </member>
- <member name="M:Aspose.Words.TabStop.GetHashCode">
- <summary>
- Calculates hash code for this object.
- </summary>
- </member>
- <member name="P:Aspose.Words.TabStop.Position">
- <summary>
- Gets the position of the tab stop in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.TabStop.Alignment">
- <summary>
- Gets or sets the alignment of text at this tab stop.
- </summary>
- </member>
- <member name="P:Aspose.Words.TabStop.Leader">
- <summary>
- Gets or sets the type of the leader line displayed under the tab character.
- </summary>
- </member>
- <member name="P:Aspose.Words.TabStop.IsClear">
- <summary>
- Returns true if this tab stop clears any existing tab stops in this position.
- </summary>
- </member>
- <member name="T:Aspose.Words.TabStopCollection">
- <summary>
- A collection of <see cref="T:Aspose.Words.TabStop" /> objects that represent custom tabs for a paragraph or a style.
- </summary>
- <remarks>
- <p>In Microsoft Word documents, a tab stop can be defined in the properties of a paragraph
- style or directly in the properties of a paragraph. A style can be based on another style.
- Therefore, the complete set of tab stops for a given object is a combination of tab stops
- defined directly on this object and tab stops inherited from the parent styles.</p>
- <p>In Aspose.Words, when you obtain a <b>TabStops</b> collection for a paragraph or a style,
- it contains only the custom tab stops defined directly for this paragraph or style.
- The collection does not include tab stops defined in the parent styles or default tab stops.</p>
- <seealso cref="T:Aspose.Words.ParagraphFormat" />
- <seealso cref="T:Aspose.Words.TabStop" />
- <seealso cref="P:Aspose.Words.Document.DefaultTabStop" />
- </remarks>
- <dev>
- This whole collection is stored in the paragraph attributes as a single attribute.
- </dev>
- </member>
- <member name="M:Aspose.Words.TabStopCollection.Equals(Aspose.Words.TabStopCollection)">
- <summary>
- Determines whether the specified TabStopCollection is equal in value to the current TabStopCollection.
- </summary>
- </member>
- <member name="M:Aspose.Words.TabStopCollection.Equals(System.Object)">
- <summary>
- Determines whether the specified object is equal in value to the current object.
- </summary>
- </member>
- <member name="M:Aspose.Words.TabStopCollection.GetHashCode">
- <summary>
- Serves as a hash function for this type.
- </summary>
- </member>
- <member name="M:Aspose.Words.TabStopCollection.Clear">
- <summary>
- Deletes all tab stop positions.
- </summary>
- </member>
- <member name="M:Aspose.Words.TabStopCollection.GetPositionByIndex(System.Int32)">
- <summary>
- Gets the position (in points) of the tab stop at the specified index.
- </summary>
- <param name="index">An index into the collection of tab stops.</param>
- <returns>The position of the tab stop.</returns>
- </member>
- <member name="M:Aspose.Words.TabStopCollection.GetIndexByPosition(System.Double)">
- <summary>
- Gets the index of a tab stop with the specified position in points.
- </summary>
- </member>
- <member name="M:Aspose.Words.TabStopCollection.Add(Aspose.Words.TabStop)">
- <summary>
- Adds or replaces a tab stop in the collection.
- </summary>
- <remarks>
- <p>If a tab stop already exists at the specified position, it is replaced.</p>
- </remarks>
- <param name="tabStop">A tab stop object to add.</param>
- </member>
- <member name="M:Aspose.Words.TabStopCollection.Add(System.Double,Aspose.Words.TabAlignment,Aspose.Words.TabLeader)">
- <summary>
- Adds or replaces a tab stop in the collection.
- </summary>
- <remarks>
- <p>If a tab stop already exists at the specified position, it is replaced.</p>
- </remarks>
- <param name="position">A position (in points) where to add the tab stop.</param>
- <param name="alignment">A <see cref="T:Aspose.Words.TabAlignment" /> value that
- specifies the alignment of text at the tab stop.</param>
- <param name="leader">A <see cref="T:Aspose.Words.TabLeader" /> value that
- specifies the type of the leader line displayed under the tab character.</param>
- </member>
- <member name="M:Aspose.Words.TabStopCollection.RemoveByPosition(System.Double)">
- <summary>
- Removes a tab stop at the specified position from the collection.
- </summary>
- <param name="position">The position (in points) of the tab stop to remove.</param>
- </member>
- <member name="M:Aspose.Words.TabStopCollection.RemoveByIndex(System.Int32)">
- <summary>
- Removes a tab stop at the specified index from the collection.
- </summary>
- <param name="index">An index into the collection of tab stops.</param>
- </member>
- <member name="M:Aspose.Words.TabStopCollection.After(System.Double)">
- <summary>
- Gets a first tab stop to the right of the specified position.
- </summary>
- <remarks>
- <p>Skips tab stops with <b>Alignment</b> set to <c>TabAlignment.Bar</c>.</p>
- </remarks>
- <param name="position">The reference position (in points).</param>
- <returns>A tab stop object or null if a suitable tab stop was not found.</returns>
- </member>
- <member name="M:Aspose.Words.TabStopCollection.Before(System.Double)">
- <summary>
- Gets a first tab stop to the left of the specified position.
- </summary>
- <remarks>
- <p>Skips tab stops with <b>Alignment</b> set to <c>TabAlignment.Bar</c>.</p>
- </remarks>
- <param name="position">The reference position (in points).</param>
- <returns>A tab stop object or null if a suitable tab stop was not found.</returns>
- </member>
- <member name="P:Aspose.Words.TabStopCollection.Count">
- <summary>
- Gets the number of tab stops in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.TabStopCollection.Item(System.Int32)">
- <overloads>Retrieves a tab stop from the collection.</overloads>
- <summary>
- Gets a tab stop at the given index.
- </summary>
- <param name="index">An index into the collection of tab stops.</param>
- </member>
- <member name="P:Aspose.Words.TabStopCollection.Item(System.Double)">
- <summary>
- Gets a tab stop at the specified position.
- </summary>
- <remarks>
- Returns null if no tab stop is found at the specified position.
- </remarks>
- <param name="position">The position (in points) of the tab stop.</param>
- </member>
- <member name="T:Aspose.Words.TextEffect">
- <summary>
- Animation effect for text runs.
- </summary>
- </member>
- <member name="F:Aspose.Words.TextEffect.None">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextEffect.LasVegasLights">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextEffect.BlinkingBackground">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextEffect.SparkleText">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextEffect.MarchingBlackAnts">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextEffect.MarchingRedAnts">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.TextEffect.Shimmer">
- <summary>
- </summary>
- </member>
- <member name="T:Aspose.Words.TextOrientation">
- <summary>
- Specifies orientation of text on a page, in a table cell or a text frame.
- </summary>
- </member>
- <member name="F:Aspose.Words.TextOrientation.Horizontal">
- <summary>
- Text is arranged horizontally (lr-tb).
- </summary>
- </member>
- <member name="F:Aspose.Words.TextOrientation.Downward">
- <summary>
- Text is rotated 90 degrees to the right to appear from top to bottom (tb-rl).
- </summary>
- </member>
- <member name="F:Aspose.Words.TextOrientation.Upward">
- <summary>
- Text is rotated 90 degrees to the left to appear from bottom to top (bt-lr).
- </summary>
- </member>
- <member name="F:Aspose.Words.TextOrientation.HorizontalRotatedFarEast">
- <summary>
- Text is arranged horizontally, but Far East characters are rotated 90 degrees to the left (lr-tb-v).
- </summary>
- </member>
- <member name="F:Aspose.Words.TextOrientation.VerticalFarEast">
- <summary>
- Far East characters appear vertical, other text is rotated 90 degrees
- to the right to appear from top to bottom (tb-rl-v).
- </summary>
- </member>
- <member name="F:Aspose.Words.TextOrientation.VerticalRotatedFarEast">
- <summary>
- Far East characters appear vertical, other text is rotated 90 degrees
- to the right to appear from top to bottom vertically, then left to right horizontally (tb-lr-v).
- </summary>
- <dev> IN: Set this value to 7 because MS Word uses this value in DOC format. </dev>
- </member>
- <member name="T:Aspose.Words.Underline">
- <summary>
- Indicates type of the underline applied to a font.
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.None">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.Single">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.Words">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.Double">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.Dotted">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.Thick">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.Dash">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.DashLong">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.DotDash">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.DotDotDash">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.Wavy">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.DottedHeavy">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.DashHeavy">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.DashLongHeavy">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.DotDashHeavy">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.DotDotDashHeavy">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.WavyHeavy">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Underline.WavyDouble">
- <summary>
- </summary>
- </member>
- <member name="T:Aspose.Words.ComHelper">
- <summary>
- Provides methods for COM clients to load a document into Aspose.Words.
- </summary>
- <remarks>
- <p>Use the <see cref="T:Aspose.Words.ComHelper" /> class to load a document from a file or stream into a
- <see cref="T:Aspose.Words.Document" /> object in a COM application.</p>
- <p>The <see cref="T:Aspose.Words.Document" /> class provides a default constructor to create a new document
- and also provides overloaded constructors to load a document from a file or stream.
- If you are using Aspose.Words from a .NET application, you can use all of the <see cref="T:Aspose.Words.Document" />
- constructors directly, but if you are using Aspose.Words from a COM application,
- only the default <see cref="T:Aspose.Words.Document" /> constructor is available.</p>
- </remarks>
- <example>
- <code>
- [VBScript]
-
- Dim helper
- Set helper = CreateObject("Aspose.Words.ComHelper")
-
- Dim doc
- Set doc = helper.Open(fileName)
- </code>
- </example>
- </member>
- <member name="M:Aspose.Words.ComHelper.#ctor">
- <summary>
- Initializes a new instance of this class.
- </summary>
- </member>
- <member name="M:Aspose.Words.ComHelper.Open(System.String)">
- <overloads>Allows a COM application to load a document.</overloads>
- <summary>
- Allows a COM application to load a <see cref="T:Aspose.Words.Document" /> from a file.
- </summary>
- <remarks>
- <p>This method is same as calling the <see cref="T:Aspose.Words.Document" /> constructor with a file name parameter.</p>
- </remarks>
- <example>
- <code>
- [VBScript]
-
- Dim helper
- Set helper = CreateObject("Aspose.Words.ComHelper")
-
- Dim doc
- Set doc = helper.Open(fileName)
- </code>
- </example>
- <param name="fileName">Filename of the document to load.</param>
- <returns>A <see cref="T:Aspose.Words.Document" /> object that represents a Word document.</returns>
- </member>
- <member name="M:Aspose.Words.ComHelper.Open(System.IO.Stream)">
- <summary>
- Allows a COM application to load <see cref="T:Aspose.Words.Document" /> from a stream.
- </summary>
- <remarks>
- <p>This method is same as calling the <see cref="T:Aspose.Words.Document" /> constructor with a stream parameter.</p>
- </remarks>
- <param name="stream">A .NET stream object that contains the document to load.</param>
- <returns>A <see cref="T:Aspose.Words.Document" /> object that represents a Word document.</returns>
- </member>
- <member name="T:Aspose.Words.ConvertUtil">
- <summary>
- Provides helper functions to convert between various measurement units.
- </summary>
- <dev>
- This is only a public wrapper that makes functions available in the public Aspose.Words namespace.
- The actual implementation is in <see cref="T:Aspose.ConvertUtilCore" />.
- </dev>
- </member>
- <member name="M:Aspose.Words.ConvertUtil.PointToPixel(System.Double)">
- <overloads>Converts points to pixels.</overloads>
- <summary>
- Converts points to pixels at 96 dpi.
- </summary>
- <param name="points">The value to convert.</param>
- <remarks>
- 1 inch equals 72 points.
- </remarks>
- </member>
- <member name="M:Aspose.Words.ConvertUtil.PointToPixel(System.Double,System.Double)">
- <summary>
- Converts points to pixels at the specified pixel resolution.
- </summary>
- <param name="points">The value to convert.</param>
- <param name="resolution">The dpi (dots per inch) resolution.</param>
- <remarks>
- 1 inch equals 72 points.
- </remarks>
- </member>
- <member name="M:Aspose.Words.ConvertUtil.PixelToPoint(System.Double)">
- <overloads>Converts pixels to points.</overloads>
- <summary>
- Converts pixels to points at 96 dpi.
- </summary>
- <param name="pixels">The value to convert.</param>
- <remarks>
- 1 inch equals 72 points.
- </remarks>
- </member>
- <member name="M:Aspose.Words.ConvertUtil.PixelToPoint(System.Double,System.Double)">
- <summary>
- Converts pixels to points at the specified pixel resolution.
- </summary>
- <param name="pixels">The value to convert.</param>
- <param name="resolution">The dpi (dots per inch) resolution.</param>
- <remarks>
- 1 inch equals 72 points.
- </remarks>
- </member>
- <member name="M:Aspose.Words.ConvertUtil.PixelToNewDpi(System.Double,System.Double,System.Double)">
- <summary>
- Converts pixels from one resolution to another.
- </summary>
- <param name="pixels">The value to convert.</param>
- <param name="oldDpi">The current dpi (dots per inch) resolution.</param>
- <param name="newDpi">The new dpi (dots per inch) resolution.</param>
- </member>
- <member name="M:Aspose.Words.ConvertUtil.InchToPoint(System.Double)">
- <summary>
- Converts inches to points.
- </summary>
- <param name="inches">The value to convert.</param>
- <remarks>
- 1 inch equals 72 points.
- </remarks>
- </member>
- <member name="M:Aspose.Words.ConvertUtil.PointToInch(System.Double)">
- <summary>
- Converts points to inches.
- </summary>
- <param name="points">The value to convert.</param>
- <remarks>
- 1 inch equals 72 points.
- </remarks>
- </member>
- <member name="M:Aspose.Words.ConvertUtil.MillimeterToPoint(System.Double)">
- <summary>
- Converts millimeters to points.
- </summary>
- <param name="millimeters">The value to convert.</param>
- <remarks>
- 1 inch equals 25.4 millimeters. 1 inch equals 72 points.
- </remarks>
- </member>
- <member name="T:Aspose.Words.NamespaceDoc">
- <summary>
- <p>The <b>Aspose.Words</b> namespace provides
- classes for generating, converting, modifying, rendering and printing Microsoft Word documents
- without utilizing Microsoft Word.</p>
- <p>Aspose.Words is written completely in C#, CLS compliant and contains only safe managed code. Microsoft Word is not required in order to use Aspose.Words.</p>
- <p>The classes in the <b>Aspose.Words</b> namespace
- 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. </p>
- <p>The main classes in this namespace are:</p>
- <list type="bullet">
- <item>
- <see cref="T:Aspose.Words.Document" /> is the main class of the object
- model that represents a Microsoft Word document.</item>
- <item>
- <see cref="T:Aspose.Words.DocumentBuilder" /> provides an
- easy way to insert content and formatting into a document.</item>
- <item>
- <see cref="T:Aspose.Words.Node" /> is the base class for all nodes
- in the document.</item>
- <item>
- <see cref="T:Aspose.Words.CompositeNode" /> is the base class
- for all nodes of the document that can contain other nodes, for example
- <see cref="T:Aspose.Words.Paragraph" />,
- <see cref="T:Aspose.Words.Section" /> and
- <see cref="T:Aspose.Words.Tables.Table" />.</item>
- </list>
- </summary>
- </member>
- <member name="T:Aspose.Words.Shaping.NamespaceDoc">
- <summary>
- The <b>Aspose.Words.Shaping</b> namespace contains classes to provide
- support for OpenType features using external text shaping engines.
- </summary>
- </member>
- <member name="T:Aspose.Words.Properties.DocumentSecurity">
- <summary>
- Used as a value for the <see cref="P:Aspose.Words.Properties.BuiltInDocumentProperties.Security" /> property.
- Specifies the security level of a document as a numeric value.
- </summary>
- </member>
- <member name="F:Aspose.Words.Properties.DocumentSecurity.None">
- <summary>
- There are no security states specified by the property.
- </summary>
- </member>
- <member name="F:Aspose.Words.Properties.DocumentSecurity.PasswordProtected">
- <summary>
- The document is password protected. (Note has never been seen in a document so far).
- </summary>
- </member>
- <member name="F:Aspose.Words.Properties.DocumentSecurity.ReadOnlyRecommended">
- <summary>
- The document to be opened read-only if possible, but the setting can be overridden.
- </summary>
- </member>
- <member name="F:Aspose.Words.Properties.DocumentSecurity.ReadOnlyEnforced">
- <summary>
- The document to always be opened read-only.
- </summary>
- </member>
- <member name="F:Aspose.Words.Properties.DocumentSecurity.ReadOnlyExceptAnnotations">
- <summary>
- The document to always be opened read-only except for annotations.
- </summary>
- </member>
- <member name="T:Aspose.Words.Properties.BuiltInDocumentProperties">
- <summary>
- A collection of built-in document properties.
- </summary>
- <remarks>
- <para>Provides access to <see cref="T:Aspose.Words.Properties.DocumentProperty" /> objects by their names (using an indexer) and
- via a set of typed properties that return values of appropriate types.</para>
- </remarks>
- <remarks>
- <p>The names of the properties are case-insensitive.</p>
- <p>The properties in the collection are sorted alphabetically by name.</p>
- </remarks>
- <seealso cref="T:Aspose.Words.Document" />
- <seealso cref="P:Aspose.Words.Document.BuiltInDocumentProperties" />
- <seealso cref="P:Aspose.Words.Document.CustomDocumentProperties" />
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Item(System.String)">
- <overloads>Returns a <see cref="T:Aspose.Words.Properties.DocumentProperty" /> object.</overloads>
- <summary>
- Returns a <see cref="T:Aspose.Words.Properties.DocumentProperty" /> object by the name of the property.
- </summary>
- <remarks>
- <para>The string names of the properties correspond to the names of the typed
- properties available from <see cref="T:Aspose.Words.Properties.BuiltInDocumentProperties" />.</para>
- <para>If you request a property that is not present in the document, but the name
- of the property is recognized as a valid built-in name, a new <see cref="T:Aspose.Words.Properties.DocumentProperty" />
- is created, added to the collection and returned. The newly created property is assigned
- a default value (empty string, zero, false or DateTime.MinValue depending on the type
- of the built-in property).</para>
- <para>If you request a property that is not present in the document and the name
- is not recognized as a built-in name, a null is returned.</para>
- </remarks>
- <param name="name">The case-insensitive name of the property to retrieve.</param>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Author">
- <summary>
- Gets or sets the name of the document's author.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Bytes">
- <summary>
- Represents an estimate of the number of bytes in the document.
- </summary>
- <remarks>
- <para>Microsoft Word does not always set this property.</para>
- <para>Aspose.Words does not update this property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Characters">
- <summary>
- Represents an estimate of the number of characters in the document.
- </summary>
- <remarks>
- <para>Aspose.Words updates this property when you call <see cref="M:Aspose.Words.Document.UpdateWordCount" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.CharactersWithSpaces">
- <summary>
- Represents an estimate of the number of characters (including spaces) in the document.
- </summary>
- <remarks>
- <para>Aspose.Words updates this property when you call <see cref="M:Aspose.Words.Document.UpdateWordCount" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Comments">
- <summary>
- Gets or sets the document comments.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Category">
- <summary>
- Gets or sets the category of the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Company">
- <summary>
- Gets or sets the company property.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.CreatedTime">
- <summary>
- Gets or sets date of the document creation in UTC.
- </summary>
- <remarks>
- <para>For documents originated from RTF format this property returns local time of the author's machine at the moment of document creation.</para>
- <para>Aspose.Words does not update this property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.HyperlinkBase">
- <summary>
- Specifies the base string used for evaluating relative hyperlinks in this document.
- </summary>
- <remarks>
- <para>Aspose.Words does not use this property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Keywords">
- <summary>
- Gets or sets the document keywords.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted">
- <summary>
- Gets or sets the date when the document was last printed in UTC.
- </summary>
- <remarks>
- <para>For documents originated from RTF format this property returns the local time of last print operation.</para>
- <para>If the document was never printed, this property will return DateTime.MinValue.</para>
- <para>Aspose.Words does not update this property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedBy">
- <summary>
- Gets or sets the name of the last author.
- </summary>
- <remarks>
- <para>Aspose.Words does not update this property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime">
- <summary>
- Gets or sets the time of the last save in UTC.
- </summary>
- <remarks>
- <para>For documents originated from RTF format this property returns the local time of last save operation.</para>
- <para>Aspose.Words does not update this property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Lines">
- <summary>
- Represents an estimate of the number of lines in the document.
- </summary>
- <remarks>
- <para>Aspose.Words updates this property when you call <see cref="M:Aspose.Words.Document.UpdateWordCount(System.Boolean)" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.LinksUpToDate">
- <summary>
- Indicates whether hyperlinks in a document are up-to-date.
- </summary>
- <remarks>
- <para>Aspose.Words does not update this property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Manager">
- <summary>
- Gets or sets the manager property.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.NameOfApplication">
- <summary>
- Gets or sets the name of the application.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Pages">
- <summary>
- Represents an estimate of the number of pages in the document.
- </summary>
- <remarks>
- <para>Aspose.Words updates this property when you call <see cref="M:Aspose.Words.Document.UpdatePageLayout" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Paragraphs">
- <summary>
- Represents an estimate of the number of paragraphs in the document.
- </summary>
- <remarks>
- <para>Aspose.Words updates this property when you call <see cref="M:Aspose.Words.Document.UpdateWordCount" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.RevisionNumber">
- <summary>
- Gets or sets the document revision number.
- </summary>
- <remarks>
- <para>Aspose.Words does not update this property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Security">
- <summary>
- Specifies the security level of a document as a numeric value.
- </summary>
- <remarks>
- <para>Use this property for informational purposes only because Microsoft Word does not always
- set this property. This property is available in DOC and OOXML documents only.</para>
- <para>To protect or unprotect a document use the
- <see cref="M:Aspose.Words.Document.Protect(Aspose.Words.ProtectionType,System.String)" /> and <see cref="M:Aspose.Words.Document.Unprotect" /> methods.</para>
- <para>Aspose.Words updates this property to a correct value before saving a document.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Subject">
- <summary>
- Gets or sets the subject of the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Template">
- <summary>
- Gets or sets the informational name of the document template.
- </summary>
- <remarks>
- <para>In Microsoft Word, this property is for informational purposes only and
- usually contains only the file name of the template without the path.</para>
- <para>Empty string means the document is attached to the Normal template.</para>
- <para>To get or set the actual name of the attached template, use the
- <see cref="P:Aspose.Words.Document.AttachedTemplate" /> property.</para>
- <seealso cref="P:Aspose.Words.Document.AttachedTemplate" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Thumbnail">
- <summary>
- <para>Gets or sets the thumbnail of the document.</para>
- </summary>
- <remarks>
- <para>For now this property is used only when a document is being exported to ePub,
- it's not read from and written to other document formats.</para>
- <para>Image of arbitrary format can be set to this property, but the format is checked during export.
- <see cref="T:System.InvalidOperationException" /> is thrown if the image is invalid or its format is unsupported for
- specific format of document.</para>
- <para>Only gif, jpeg and png images can be used for ePub publication.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Title">
- <summary>
- Gets or sets the title of the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.TotalEditingTime">
- <summary>
- Gets or sets the total editing time in minutes.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.ContentType">
- <summary>
- Gets or sets the ContentStatus of the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.ContentStatus">
- <summary>
- Gets or sets the ContentStatus of the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Version">
- <summary>
- Represents the version number of the application that created the document.
- </summary>
- <remarks>
- <para>When a document was created by Microsoft Word, then high 16 bit represent
- the major version and low 16 bit represent the build number.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.Words">
- <summary>
- Represents an estimate of the number of words in the document.
- </summary>
- <remarks>
- <para>Aspose.Words updates this property when you call <see cref="M:Aspose.Words.Document.UpdateWordCount" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.HeadingPairs">
- <summary>
- Specifies document headings and their names.
- </summary>
- <remarks>
- <para>Every heading pair occupies two elements in this array.</para>
- <para>The first element of the pair is a <see cref="T:System.String" /> and specifies the heading name.
- The second element of the pair is an <see cref="T:System.Int32" /> and specifies the count of document
- parts for this heading in the <see cref="P:Aspose.Words.Properties.BuiltInDocumentProperties.TitlesOfParts" /> property.</para>
- <para>The total sum of counts for all heading pairs in this property must be equal to the
- number of elements in the <see cref="P:Aspose.Words.Properties.BuiltInDocumentProperties.TitlesOfParts" /> property.</para>
- <para>Aspose.Words does not update this property.</para>
- <seealso cref="P:Aspose.Words.Properties.BuiltInDocumentProperties.TitlesOfParts" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.BuiltInDocumentProperties.TitlesOfParts">
- <summary>
- Each string in the array specifies the name of a part in the document.
- </summary>
- <remarks>
- <para>Aspose.Words does not update this property.</para>
- <seealso cref="P:Aspose.Words.Properties.BuiltInDocumentProperties.HeadingPairs" />
- </remarks>
- </member>
- <member name="T:Aspose.Words.Properties.CustomDocumentProperties">
- <summary>
- A collection of custom document properties.
- </summary>
- <remarks>
- <p>Each <see cref="T:Aspose.Words.Properties.DocumentProperty" /> object represents a custom property of a container document.</p>
- </remarks>
- <remarks>
- <p>The names of the properties are case-insensitive.</p>
- <p>The properties in the collection are sorted alphabetically by name.</p>
- </remarks>
- <seealso cref="T:Aspose.Words.Document" />
- <seealso cref="P:Aspose.Words.Document.BuiltInDocumentProperties" />
- <seealso cref="P:Aspose.Words.Document.CustomDocumentProperties" />
- </member>
- <member name="M:Aspose.Words.Properties.CustomDocumentProperties.Add(System.String,System.String)">
- <overloads>Creates a new custom document property.</overloads>
- <summary>
- Creates a new custom document property of the <b>PropertyType.String</b> data type.
- </summary>
- <param name="name">The name of the property.</param>
- <param name="value">The value of the property.</param>
- <returns>The newly created property object.</returns>
- </member>
- <member name="M:Aspose.Words.Properties.CustomDocumentProperties.Add(System.String,System.Int32)">
- <summary>
- Creates a new custom document property of the <b>PropertyType.Number</b> data type.
- </summary>
- <param name="name">The name of the property.</param>
- <param name="value">The value of the property.</param>
- <returns>The newly created property object.</returns>
- </member>
- <member name="M:Aspose.Words.Properties.CustomDocumentProperties.Add(System.String,System.DateTime)">
- <summary>
- Creates a new custom document property of the <b>PropertyType.DateTime</b> data type.
- </summary>
- <param name="name">The name of the property.</param>
- <param name="value">The value of the property.</param>
- <returns>The newly created property object.</returns>
- </member>
- <member name="M:Aspose.Words.Properties.CustomDocumentProperties.Add(System.String,System.Boolean)">
- <summary>
- Creates a new custom document property of the <b>PropertyType.Boolean</b> data type.
- </summary>
- <param name="name">The name of the property.</param>
- <param name="value">The value of the property.</param>
- <returns>The newly created property object.</returns>
- </member>
- <member name="M:Aspose.Words.Properties.CustomDocumentProperties.Add(System.String,System.Double)">
- <summary>
- Creates a new custom document property of the <b>PropertyType.Float</b> data type.
- </summary>
- <param name="name">The name of the property.</param>
- <param name="value">The value of the property.</param>
- <returns>The newly created property object.</returns>
- </member>
- <member name="M:Aspose.Words.Properties.CustomDocumentProperties.AddLinkToContent(System.String,System.String)">
- <summary>
- Creates a new linked to content custom document property.
- </summary>
- <param name="name">The name of the property.</param>
- <param name="linkSource">The source of the property.</param>
- <returns>The newly created property object or null when the linkSource is invalid.</returns>
- </member>
- <member name="T:Aspose.Words.Properties.DocumentProperty">
- <summary>
- Represents a custom or built-in document property.
- </summary>
- <seealso cref="T:Aspose.Words.Properties.DocumentPropertyCollection" />
- </member>
- <member name="M:Aspose.Words.Properties.DocumentProperty.ToString">
- <summary>
- Returns the property value as a string formatted according to the current locale.
- </summary>
- <remarks>
- <p>Converts a boolean property into "Y" or "N".
- Converts a date property into a short date string.
- For all other types converts a property using Object.ToString().</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Properties.DocumentProperty.ToInt">
- <summary>
- Returns the property value as integer.
- </summary>
- <remarks>
- Throws an exception if the property type is not <see cref="F:Aspose.Words.Properties.PropertyType.Number" />.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Properties.DocumentProperty.ToDouble">
- <summary>
- Returns the property value as double.
- </summary>
- <remarks>
- Throws an exception if the property type is not <see cref="F:Aspose.Words.Properties.PropertyType.Number" />.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Properties.DocumentProperty.ToDateTime">
- <summary>
- Returns the property value as DateTime in UTC.
- </summary>
- <remarks>
- <p>Throws an exception if the property type is not <see cref="F:Aspose.Words.Properties.PropertyType.DateTime" />.</p>
- <p>Microsoft Word stores only the date part (no time) for custom date properties.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Properties.DocumentProperty.ToBool">
- <summary>
- Returns the property value as bool.
- </summary>
- <remarks>
- <p>Throws an exception if the property type is not <see cref="F:Aspose.Words.Properties.PropertyType.Boolean" />.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Properties.DocumentProperty.ToByteArray">
- <summary>
- Returns the property value as byte array.
- </summary>
- <remarks>
- <p>Throws an exception if the property type is not <see cref="F:Aspose.Words.Properties.PropertyType.ByteArray" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.DocumentProperty.Name">
- <summary>
- Returns the name of the property.
- </summary>
- <remarks>
- <para>Cannot be null and cannot be an empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.DocumentProperty.Value">
- <summary>
- Gets or sets the value of the property.
- </summary>
- <remarks>
- <para>Cannot be null.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Properties.DocumentProperty.Type">
- <summary>
- Gets the data type of the property.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.DocumentProperty.LinkSource">
- <summary>
- Gets the source of a linked custom document property.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.DocumentProperty.IsLinkToContent">
- <summary>
- Shows whether this property is linked to content or not.
- </summary>
- </member>
- <member name="T:Aspose.Words.Properties.DocumentPropertyCollection">
- <summary>
- Base class for <see cref="T:Aspose.Words.Properties.BuiltInDocumentProperties" /> and <see cref="T:Aspose.Words.Properties.CustomDocumentProperties" /> collections.
- </summary>
- <remarks>
- <p>The names of the properties are case-insensitive.</p>
- <p>The properties in the collection are sorted alphabetically by name.</p>
- </remarks>
- <seealso cref="T:Aspose.Words.Properties.BuiltInDocumentProperties" />
- <seealso cref="T:Aspose.Words.Properties.CustomDocumentProperties" />
- </member>
- <member name="M:Aspose.Words.Properties.DocumentPropertyCollection.GetEnumerator">
- <summary>
- Returns an enumerator object that can be used to iterate over all items in the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Properties.DocumentPropertyCollection.Contains(System.String)">
- <summary>
- Returns true if a property with the specified name exists in the collection.
- </summary>
- <param name="name">The case-insensitive name of the property.</param>
- <returns>True if the property exists in the collection; false otherwise.</returns>
- </member>
- <member name="M:Aspose.Words.Properties.DocumentPropertyCollection.IndexOf(System.String)">
- <summary>
- Gets the index of a property by name.
- </summary>
- <param name="name">The case-insensitive name of the property.</param>
- <returns>The zero based index. Negative value if not found.</returns>
- </member>
- <member name="M:Aspose.Words.Properties.DocumentPropertyCollection.Remove(System.String)">
- <summary>
- Removes a property with the specified name from the collection.
- </summary>
- <param name="name">The case-insensitive name of the property.</param>
- </member>
- <member name="M:Aspose.Words.Properties.DocumentPropertyCollection.RemoveAt(System.Int32)">
- <summary>
- Removes a property at the specified index.
- </summary>
- <param name="index">The zero based index.</param>
- </member>
- <member name="M:Aspose.Words.Properties.DocumentPropertyCollection.Clear">
- <summary>
- Removes all properties from the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.DocumentPropertyCollection.Count">
- <summary>
- Gets number of items in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Properties.DocumentPropertyCollection.Item(System.String)">
- <overloads>Provides access to the collection items.</overloads>
- <summary>
- Returns a <see cref="T:Aspose.Words.Properties.DocumentProperty" /> object by the name of the property.
- </summary>
- <remarks>
- <p>Returns null if a property with the specified name is not found.</p>
- </remarks>
- <param name="name">The case-insensitive name of the property to retrieve.</param>
- </member>
- <member name="P:Aspose.Words.Properties.DocumentPropertyCollection.Item(System.Int32)">
- <summary>
- Returns a <see cref="T:Aspose.Words.Properties.DocumentProperty" /> object by index.
- </summary>
- <param name="index">Zero-based index of the <see cref="T:Aspose.Words.Properties.DocumentProperty" /> to retrieve.</param>
- </member>
- <member name="T:Aspose.Words.Properties.NamespaceDoc">
- <summary>
- <p>The <b>Aspose.Words.Properties</b> namespace provides classes to work
- with custom and built-in document properties such as title, keywords, company etc.</p>
- </summary>
- </member>
- <member name="T:Aspose.Words.Properties.PropertyType">
- <summary>
- Specifies data type of a document property.
- </summary>
- <seealso cref="T:Aspose.Words.Properties.DocumentProperty" />
- <seealso cref="P:Aspose.Words.Properties.DocumentProperty.Type" />
- </member>
- <member name="F:Aspose.Words.Properties.PropertyType.Boolean">
- <summary>
- The property is a boolean value.
- </summary>
- </member>
- <member name="F:Aspose.Words.Properties.PropertyType.DateTime">
- <summary>
- The property is a date time value.
- </summary>
- </member>
- <member name="F:Aspose.Words.Properties.PropertyType.Double">
- <summary>
- The property is a floating number.
- </summary>
- </member>
- <member name="F:Aspose.Words.Properties.PropertyType.Number">
- <summary>
- The property is an integer number.
- </summary>
- </member>
- <member name="F:Aspose.Words.Properties.PropertyType.String">
- <summary>
- The property is a string value.
- </summary>
- </member>
- <member name="F:Aspose.Words.Properties.PropertyType.StringArray">
- <summary>
- The property is an array of strings.
- </summary>
- </member>
- <member name="F:Aspose.Words.Properties.PropertyType.ObjectArray">
- <summary>
- The property is an array of objects.
- </summary>
- </member>
- <member name="F:Aspose.Words.Properties.PropertyType.ByteArray">
- <summary>
- The property is an array of bytes.
- </summary>
- </member>
- <member name="F:Aspose.Words.Properties.PropertyType.Other">
- <summary>
- The property is some other type.
- </summary>
- </member>
- <member name="T:Aspose.Words.BuildingBlocks.BuildingBlock">
- <summary>
- Represents a glossary document entry such as a Building Block, AutoText or an AutoCorrect entry.
- </summary>
- <remarks>
- <p>
- <see cref="T:Aspose.Words.BuildingBlocks.BuildingBlock" /> can contain only <see cref="T:Aspose.Words.Section" /> nodes.</p>
- <p>
- <see cref="T:Aspose.Words.BuildingBlocks.BuildingBlock" /> can only be a child of <see cref="T:Aspose.Words.BuildingBlocks.GlossaryDocument" />.</p>
- <para>You can create new building blocks and insert them into a glossary document.
- You can modify or delete existing building blocks. You can copy or move building blocks
- between documents. You can insert content of a building block into a document.</para>
- <para>Corresponds to the <b>docPart</b>, <b>docPartPr</b> and <b>docPartBody</b> elements in OOXML.</para>
- <seealso cref="T:Aspose.Words.BuildingBlocks.GlossaryDocument" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.BuildingBlocks.BuildingBlock.#ctor(Aspose.Words.BuildingBlocks.GlossaryDocument)">
- <summary>
- Initializes a new instance of this class.
- </summary>
- <remarks>
- <p>When <see cref="T:Aspose.Words.BuildingBlocks.BuildingBlock" /> is created, it belongs to the specified glossary document,
- but is not yet part of the glossary document and <see cref="P:Aspose.Words.Node.ParentNode" /> is <c>null</c>.</p>
- <p>To append <see cref="T:Aspose.Words.BuildingBlocks.BuildingBlock" /> to a <see cref="T:Aspose.Words.BuildingBlocks.GlossaryDocument" /> use
- <see cref="M:Aspose.Words.CompositeNode.AppendChild(Aspose.Words.Node)" />.</p>
- </remarks>
- <param name="glossaryDoc">The owner document.</param>
- </member>
- <member name="M:Aspose.Words.BuildingBlocks.BuildingBlock.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- <para>Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitBuildingBlockStart(Aspose.Words.BuildingBlocks.BuildingBlock)" />, then calls
- <see cref="M:Aspose.Words.Node.Accept(Aspose.Words.DocumentVisitor)" /> for all child nodes of this building block, then calls
- <see cref="M:Aspose.Words.DocumentVisitor.VisitBuildingBlockEnd(Aspose.Words.BuildingBlocks.BuildingBlock)" />.</para>
- </remarks>
- <remarks>
- <para>
- Note: A building block node and its children are not visited when you execute a
- Visitor over a <see cref="T:Aspose.Words.Document" />. If you want to execute a Visitor over a
- building block, you need to execute the visitor over <see cref="T:Aspose.Words.BuildingBlocks.GlossaryDocument" /> or
- call <see cref="M:Aspose.Words.BuildingBlocks.BuildingBlock.Accept(Aspose.Words.DocumentVisitor)" />.
- </para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.BuildingBlock.NodeType">
- <summary>
- Returns the <see cref="F:Aspose.Words.NodeType.BuildingBlock" /> value.
- </summary>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.BuildingBlock.Sections">
- <summary>
- Returns a collection that represents all sections in the building block.
- </summary>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.BuildingBlock.FirstSection">
- <summary>
- Gets the first section in the building block.
- </summary>
- <remarks>
- Returns <c>null</c> if there are no sections.
- </remarks>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.BuildingBlock.LastSection">
- <summary>
- Gets the last section in the building block.
- </summary>
- <remarks>
- Returns <c>null</c> if there are no sections.
- </remarks>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.BuildingBlock.Name">
- <summary>
- Gets or sets the name of this building block.
- </summary>
- <remarks>
- <para>The name may contain any string content, usually a friendly identifier.
- Multiple building blocks can have the same name.</para>
- <para>Cannot be <c>null</c> and cannot be an empty string.</para>
- <para>Corresponds to the <b>docPartPr.name</b> element in OOXML.</para>
- <seealso cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Gallery" />
- <seealso cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Category" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.BuildingBlock.Guid">
- <summary>
- Gets or sets an identifier (a 128-bit GUID) that uniquely identifies this building block.
- </summary>
- <remarks>
- <para>Can be used by an application to uniquely reference a building block regardless of
- different naming due to localization.</para>
- <para>Corresponds to the <b>docPartPr.guid</b> element in OOXML.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.BuildingBlock.Description">
- <summary>
- Gets or sets the description associated with this building block.
- </summary>
- <remarks>
- <para>The description may contain any string content, usually additional information.</para>
- <para>Cannot be <c>null</c>, but can be an empty string.</para>
- <para>Corresponds to the <b>docPartPr.description</b> element in OOXML.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.BuildingBlock.Gallery">
- <summary>
- Specifies the first-level categorization for the building block for the purposes of
- classification or user interface sorting.
- </summary>
- <remarks>
- <para>Building blocks in Microsoft Word user interface are arranged
- into Galleries. Each <see cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Gallery" /> can have multiple Categories. Each block within
- a <see cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Category" /> has a <see cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Name" />.</para>
- <para>Corresponds to the <b>docPartPr.category.gallery</b> element in OOXML.</para>
- <seealso cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Category" />
- <seealso cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Name" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.BuildingBlock.Category">
- <summary>
- Specifies the second-level categorization for the building block.
- </summary>
- <remarks>
- <para>Building blocks in Microsoft Word user interface are arranged
- into Galleries. Each <see cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Gallery" /> can have multiple Categories. Each block within
- a <see cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Category" /> has a <see cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Name" />.</para>
- <para>Cannot be <c>null</c> and cannot be an empty string.</para>
- <para>Corresponds to the <b>docPartPr.category.name</b> element in OOXML.</para>
- <seealso cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Gallery" />
- <seealso cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Name" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.BuildingBlock.Behavior">
- <summary>
- Specifies the behavior that shall be applied when the contents of the building block
- is inserted into the main document.
- </summary>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.BuildingBlock.Type">
- <summary>
- Specifies the building block type.
- </summary>
- <remarks>
- <para>The building block type can influence the visibility and behavior of the
- building block in Microsoft Word.</para>
- <para>Corresponds to the <b>docPartPr.types</b> element in OOXML.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.BuildingBlocks.BuildingBlockBehavior">
- <summary>
- Specifies the behavior that shall be applied to the contents of the building block
- when it is inserted into the main document.
- </summary>
- <remarks>
- <para>Corresponds to the <b>ST_DocPartBehavior</b> type in OOXML.</para>
- <seealso cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Behavior" />
- </remarks>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockBehavior.Content">
- <summary>
- Specifies that the building block shall be inserted as inline content.
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockBehavior.Paragraph">
- <summary>
- Specifies that the building block shall be inserted into its own paragraph.
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockBehavior.Page">
- <summary>
- Specifies that the building block shall be added into its own page.
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockBehavior.Default">
- <summary>
- Same as <see cref="F:Aspose.Words.BuildingBlocks.BuildingBlockBehavior.Content" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.BuildingBlocks.BuildingBlockCollection">
- <summary>
- A collection of <see cref="T:Aspose.Words.BuildingBlocks.BuildingBlock" /> objects in the document.
- </summary>
- <remarks>
- <para>You do not create instances of this class directly. To access a collection
- of building blocks use the <see cref="P:Aspose.Words.BuildingBlocks.GlossaryDocument.BuildingBlocks" /> property.</para>
- <seealso cref="T:Aspose.Words.BuildingBlocks.GlossaryDocument" />
- <seealso cref="P:Aspose.Words.BuildingBlocks.GlossaryDocument.BuildingBlocks" />
- <seealso cref="T:Aspose.Words.BuildingBlocks.BuildingBlock" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.BuildingBlocks.BuildingBlockCollection.ToArray">
- <summary>
- Copies all building blocks from the collection to a new array of building blocks.
- </summary>
- <returns>An array of building blocks.</returns>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.BuildingBlockCollection.Item(System.Int32)">
- <summary>
- Retrieves a building block at the given index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the list of building blocks.</param>
- </member>
- <member name="T:Aspose.Words.BuildingBlocks.BuildingBlockGallery">
- <summary>
- Specifies the predefined gallery into which a building block is classified.
- </summary>
- <remarks>
- <para>Corresponds to the <b>ST_DocPartGallery</b> type in OOXML.</para>
- <seealso cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Gallery" />
- </remarks>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.All">
- <summary>
- Specifies that this glossary document entry shall be associated with all possible gallery classification values.
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.AutoText">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.Bibliography">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CoverPage">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomAutoText">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomBibliography">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomCoverPage">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomEquations">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomFooters">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomHeaders">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.Custom1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.Custom2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.Custom3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.Custom4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.Custom5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomPageNumber">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomPageNumberAtBottom">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomPageNumberAtMargin">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomPageNumberAtTop">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomQuickParts">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomTableOfContents">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomTables">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomTextBox">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.CustomWatermarks">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.NoGallery">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.QuickParts">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.Equations">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.Footers">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.Headers">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.PageNumber">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.PageNumberAtBottom">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.PageNumberAtMargin">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.PageNumberAtTop">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.StructuredDocumentTagPlaceholderText">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.TableOfContents">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.Tables">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.TextBox">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.Watermarks">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.Default">
- <summary>
- Same as <see cref="F:Aspose.Words.BuildingBlocks.BuildingBlockGallery.All" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.BuildingBlocks.BuildingBlockType">
- <summary>
- Specifies a building block type. The type might affect the visibility and behavior of the building block
- in Microsoft Word.
- </summary>
- <remarks>
- <para>Corresponds to the <b>ST_DocPartType</b> type in OOXML.</para>
- <seealso cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Type" />
- </remarks>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockType.None">
- <summary>
- No type information is specified for the building block.
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockType.AutomaticallyReplaceNameWithContent">
- <summary>
- Allows the building block to be automatically inserted into the document whenever
- its name is entered into an application.
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockType.StructuredDocumentTagPlaceholderText">
- <summary>
- The building block is a structured document tag placeholder text.
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockType.FormFieldHelpText">
- <summary>
- The building block is a form field help text.
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockType.Normal">
- <summary>
- The building block is a normal (i.e. regular) glossary document entry.
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockType.AutoCorrect">
- <summary>
- The building block is associated with the spelling and grammar tools.
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockType.AutoText">
- <summary>
- The building block is an AutoText entry.
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockType.All">
- <summary>
- The building block is associated with all types.
- </summary>
- </member>
- <member name="F:Aspose.Words.BuildingBlocks.BuildingBlockType.Default">
- <summary>
- Save as <see cref="F:Aspose.Words.BuildingBlocks.BuildingBlockType.None" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.BuildingBlocks.GlossaryDocument">
- <summary>
- 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.
- </summary>
- <remarks>
- <para>Some documents, usually templates, can contain AutoText, AutoCorrect entries
- and/or Building Blocks (also known as <i>glossary document entries</i>, <i>document parts</i>
- or <i>building blocks</i>).</para>
- <para>To access building blocks, you need to load a document into a <see cref="T:Aspose.Words.Document" />
- object. Building blocks will be available via the <see cref="P:Aspose.Words.Document.GlossaryDocument" /> property.</para>
- <para>
- <see cref="T:Aspose.Words.BuildingBlocks.GlossaryDocument" /> can contain any number of <see cref="T:Aspose.Words.BuildingBlocks.BuildingBlock" /> objects.
- Each <see cref="T:Aspose.Words.BuildingBlocks.BuildingBlock" /> represents one document part.</para>
- <para>Corresponds to the <b>glossaryDocument</b> and <b>docParts</b> elements in OOXML.</para>
- <seealso cref="T:Aspose.Words.Document" />
- <seealso cref="P:Aspose.Words.Document.GlossaryDocument" />
- <seealso cref="T:Aspose.Words.BuildingBlocks.BuildingBlock" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.BuildingBlocks.GlossaryDocument.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- <para>Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitGlossaryDocumentStart(Aspose.Words.BuildingBlocks.GlossaryDocument)" />, then calls <see cref="M:Aspose.Words.Node.Accept(Aspose.Words.DocumentVisitor)" />
- for all child nodes of this node and then calls <see cref="M:Aspose.Words.DocumentVisitor.VisitGlossaryDocumentEnd(Aspose.Words.BuildingBlocks.GlossaryDocument)" />
- at the end.</para>
- </remarks>
- <remarks>
- <para>
- Note: A glossary document node and its children are not visited when you execute a
- Visitor over a <see cref="T:Aspose.Words.Document" />. If you want to execute a Visitor over a
- glossary document, you need to call <see cref="M:Aspose.Words.BuildingBlocks.GlossaryDocument.Accept(Aspose.Words.DocumentVisitor)" />.
- </para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.BuildingBlocks.GlossaryDocument.GetBuildingBlock(Aspose.Words.BuildingBlocks.BuildingBlockGallery,System.String,System.String)">
- <summary>
- Finds a building block using the specified gallery, category and name.
- </summary>
- <remarks>
- <para>This is a convenience method that iterates over all building blocks
- in this collection and returns the first building block that matches
- the specified gallery, category and name.</para>
- <para>Microsoft Word organizes building blocks into galleries. The galleries
- are predefined using the <see cref="T:Aspose.Words.BuildingBlocks.BuildingBlockGallery" /> enum.
- Within each gallery, building blocks can be organized into one or more categories.
- The category name is a string. Each building block has a name. A building block
- name is not guaranteed to be unique.</para>
- </remarks>
- <param name="gallery">The gallery criteria.</param>
- <param name="category">The category criteria. Can be null, in which case it will not be used for comparison.</param>
- <param name="name">The building block name criteria.</param>
- <returns>The matching building block or null if a match was not found.</returns>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.GlossaryDocument.NodeType">
- <summary>
- Returns the <see cref="F:Aspose.Words.NodeType.GlossaryDocument" /> value.
- </summary>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.GlossaryDocument.BuildingBlocks">
- <summary>
- Returns a typed collection that represents all building blocks in the glossary document.
- </summary>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.GlossaryDocument.FirstBuildingBlock">
- <summary>
- Gets the first building block in the glossary document.
- </summary>
- <remarks>
- Returns <c>null</c> if there are no building blocks available.
- </remarks>
- </member>
- <member name="P:Aspose.Words.BuildingBlocks.GlossaryDocument.LastBuildingBlock">
- <summary>
- Gets the last building block in the glossary document.
- </summary>
- <remarks>
- Returns <c>null</c> if there are no building blocks available.
- </remarks>
- </member>
- <member name="T:Aspose.Words.BuildingBlocks.NamespaceDoc">
- <summary>
- <p>The <b>Aspose.Words.BuildingBlocks</b> namespace provides classes that allow to access
- and use AutoText, AutoCorrect entries and Building Blocks in a document.</p>
- </summary>
- </member>
- <member name="T:Aspose.Words.Loading.IResourceLoadingCallback">
- <summary>
- Implement this interface if you want to control how Aspose.Words loads external resource when
- importing a document and inserting images using <see cref="T:Aspose.Words.DocumentBuilder" />.
- </summary>
- </member>
- <member name="M:Aspose.Words.Loading.IResourceLoadingCallback.ResourceLoading(Aspose.Words.Loading.ResourceLoadingArgs)">
- <summary>
- Called when Aspose.Words loads any external resource.
- </summary>
- </member>
- <member name="T:Aspose.Words.Loading.NamespaceDoc">
- <summary>
- <para>The <b>Aspose.Words.Loading</b> namespace provides classes and enumerations that
- allow to specify additional options when loading documents.</para>
- </summary>
- </member>
- <member name="T:Aspose.Words.Loading.ResourceLoadingAction">
- <summary>
- Specifies the mode of resource loading.
- </summary>
- </member>
- <member name="F:Aspose.Words.Loading.ResourceLoadingAction.Default">
- <summary>
- Aspose.Words will load this resource as usual.
- </summary>
- </member>
- <member name="F:Aspose.Words.Loading.ResourceLoadingAction.Skip">
- <summary>
- Aspose.Words will skip loading of this resource.
- Only link without data will be stored for an image, CSS style sheet will be ignored for HTML format.
- </summary>
- </member>
- <member name="F:Aspose.Words.Loading.ResourceLoadingAction.UserProvided">
- <summary>
- Aspose.Words will use byte array provided by user in <see cref="M:Aspose.Words.Loading.ResourceLoadingArgs.SetData(System.Byte[])" /> as resource data.
- </summary>
- </member>
- <member name="T:Aspose.Words.Loading.ResourceLoadingArgs">
- <summary>
- Provides data for the <see cref="M:Aspose.Words.Loading.IResourceLoadingCallback.ResourceLoading(Aspose.Words.Loading.ResourceLoadingArgs)" /> method.
- </summary>
- </member>
- <member name="M:Aspose.Words.Loading.ResourceLoadingArgs.SetData(System.Byte[])">
- <summary>
- Sets user provided data of the resource which is used
- if <see cref="M:Aspose.Words.Loading.IResourceLoadingCallback.ResourceLoading(Aspose.Words.Loading.ResourceLoadingArgs)" />
- returns <see cref="F:Aspose.Words.Loading.ResourceLoadingAction.UserProvided" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Loading.ResourceLoadingArgs.ResourceType">
- <summary>
- Type of resource.
- </summary>
- </member>
- <member name="P:Aspose.Words.Loading.ResourceLoadingArgs.Uri">
- <summary>
- <para>URI of the resource which is used for downloading
- if <see cref="M:Aspose.Words.Loading.IResourceLoadingCallback.ResourceLoading(Aspose.Words.Loading.ResourceLoadingArgs)" />
- returns <see cref="F:Aspose.Words.Loading.ResourceLoadingAction.Default" />.</para>
- <para>Initially it's set to absolute URI of the resource,
- but user can redefine it to any value.</para>
- </summary>
- </member>
- <member name="P:Aspose.Words.Loading.ResourceLoadingArgs.OriginalUri">
- <summary>
- Original URI of the resource as specified in imported document.
- </summary>
- </member>
- <member name="T:Aspose.Words.Loading.ResourceType">
- <summary>
- Type of loaded resource.
- </summary>
- </member>
- <member name="F:Aspose.Words.Loading.ResourceType.Image">
- <summary>
- Image.
- </summary>
- </member>
- <member name="F:Aspose.Words.Loading.ResourceType.CssStyleSheet">
- <summary>
- Css style sheet.
- </summary>
- </member>
- <member name="F:Aspose.Words.Loading.ResourceType.Document">
- <summary>
- Document.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.HyphenationOptions">
- <summary>
- Allows to configure document hyphenation options.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.HyphenationOptions.AutoHyphenation">
- <summary>
- Gets or sets value determining whether automatic hyphenation is turned on for the document.
- Default value for this property is <b>false</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.HyphenationOptions.ConsecutiveHyphenLimit">
- <summary>
- Gets or sets the maximum number of consecutive lines that can end with hyphens.
- Default value for this property is 0.
- </summary>
- <remarks>
- <p>If value of this property is set to 0, any number of consecutive lines can end with hyphens.</p>
- <p>The property does not have effect when saving to fixed page formats e.g. PDF.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Settings.HyphenationOptions.HyphenationZone">
- <summary>
- Gets or sets the distance in 1/20 of a point from the right margin within which you do not want
- to hyphenate words.
- Default value for this property is 360 (0.25 inch).
- </summary>
- <dev>
- MS Word does not hyphenate words starting inside the hyphenation zone.
- A smaller zone reduces the raggedness of the right margin, but more words may require hyphens.
- A larger zone increases the raggedness of the right margin, but fewer words may require hyphens.
- </dev>
- </member>
- <member name="P:Aspose.Words.Settings.HyphenationOptions.HyphenateCaps">
- <summary>
- Gets or sets value determining whether words written in all capital letters are hyphenated.
- Default value for this property is <b>true</b>.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.Compatibility">
- <summary>
- Specifies names of compatibility options.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.MsWordVersion">
- <summary>
- Allows Aspose.Wods to mimic MS Word version-specific application behavior.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MsWordVersion.Word2000">
- <summary>
- Optimize Aspose.Words behavior to match MS Word 2000 version.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MsWordVersion.Word2002">
- <summary>
- Optimize Aspose.Words behavior to match MS Word 2002 version.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MsWordVersion.Word2003">
- <summary>
- Optimize Aspose.Words behavior to match MS Word 2003 version.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MsWordVersion.Word2007">
- <summary>
- Optimize Aspose.Words behavior to match MS Word 2007 version.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MsWordVersion.Word2010">
- <summary>
- Optimize Aspose.Words behavior to match MS Word 2010 version.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MsWordVersion.Word2013">
- <summary>
- Optimize Aspose.Words behavior to match MS Word 2013 version.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MsWordVersion.Word2016">
- <summary>
- Optimize Aspose.Words behavior to match MS Word 2016 version.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MsWordVersion.Word2019">
- <summary>
- Optimize Aspose.Words behavior to match MS Word 2019 version.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.MultiplePagesType">
- <summary>
- Specifies how document is printed out.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MultiplePagesType.Normal">
- <summary>
- Normal printing, no multiple pages specified.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MultiplePagesType.MirrorMargins">
- <summary>
- Swaps left and right margins on facing pages.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MultiplePagesType.TwoPagesPerSheet">
- <summary>
- Prints two pages per sheet.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MultiplePagesType.BookFoldPrinting">
- <summary>
- Specifies whether to print the document as a book fold.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MultiplePagesType.BookFoldPrintingReverse">
- <summary>
- Specifies whether to print the document as a reverse book fold.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MultiplePagesType.Default">
- <summary>
- Default value is <see cref="F:Aspose.Words.Settings.MultiplePagesType.Normal" /></summary>
- </member>
- <member name="T:Aspose.Words.Settings.MailMergeCheckErrors">
- <summary>
- Specifies how Microsoft Word will report errors detected during mail merge.
- </summary>
- <seealso cref="P:Aspose.Words.Settings.MailMergeSettings.CheckErrors" />
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeCheckErrors.Simulate">
- <summary>
- Simulate the merge and report errors in a new document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeCheckErrors.PauseOnError">
- <summary>
- Complete the merge and pause to report errors.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeCheckErrors.CollectErrors">
- <summary>
- Complete the merge and report errors in a new document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeCheckErrors.Default">
- <summary>
- Equals to the <see cref="F:Aspose.Words.Settings.MailMergeCheckErrors.PauseOnError" /> value.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.NamespaceDoc">
- <summary>
- <p>The <b>Aspose.Words.Settings</b> namespace 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.</p>
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.OdsoDataSourceType">
- <summary>
- Specifies the type of the external data source to be connected to as part of the ODSO connection information.
- </summary>
- <remarks>
- <para>The OOXML specification is very vague for this enum. I guess it might correspond to the WdMergeSubType
- enumeration http://msdn.microsoft.com/en-us/library/bb237801.aspx.</para>
- <seealso cref="P:Aspose.Words.Settings.Odso.DataSourceType" />
- </remarks>
- <dev>Do not renumber these.</dev>
- </member>
- <member name="F:Aspose.Words.Settings.OdsoDataSourceType.Text">
- <summary>
- Specifies that a given document has been connected to a text file.
- Possibly wdMergeSubTypeOther.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.OdsoDataSourceType.Database">
- <summary>
- Specifies that a given document has been connected to a database.
- Possibly wdMergeSubTypeAccess.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.OdsoDataSourceType.AddressBook">
- <summary>
- Specifies that a given document has been connected to an address book of contacts.
- Possibly wdMergeSubTypeOAL.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.OdsoDataSourceType.Document1">
- <summary>
- Specifies that a given document has been connected to another document format supported by the producing application.
- Possibly wdMergeSubTypeOLEDBWord.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.OdsoDataSourceType.Document2">
- <summary>
- Specifies that a given document has been connected to another document format supported by the producing application.
- Possibly wdMergeSubTypeWorks.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.OdsoDataSourceType.Native">
- <summary>
- Specifies that a given document has been connected to another document format native to the producing application.
- Possibly wdMergeSubTypeOLEDBText
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.OdsoDataSourceType.Email">
- <summary>
- Specifies that a given document has been connected to an e-mail application.
- Possibly wdMergeSubTypeOutlook.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.OdsoDataSourceType.None">
- <summary>
- The type of the external data source is not specified.
- Possibly wdMergeSubTypeWord.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.OdsoDataSourceType.Legacy">
- <summary>
- Specifies that a given document has been connected to a legacy document format supported by the producing application
- Possibly wdMergeSubTypeWord2000.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.OdsoDataSourceType.Master">
- <summary>
- Specifies that a given document has been connected to a data source which aggregates other data sources.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.OdsoDataSourceType.Default">
- <summary>
- Equals to <see cref="F:Aspose.Words.Settings.OdsoDataSourceType.None" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.OdsoFieldMapData">
- <summary>
- Specifies how a column in the external data source shall be mapped to the predefined merge fields within the document.
- </summary>
- <remarks>
- <para>Microsoft Word provides some predefined merge field names that it allows to insert into a document as MERGEFIELD or
- use in the ADDRESSBLOCK or GREETINGLINE fields. The information specified in <see cref="T:Aspose.Words.Settings.OdsoFieldMapData" />
- allows to map one column in the external data source to a single predefined merge field.</para>
- <seealso cref="T:Aspose.Words.Settings.OdsoFieldMapDataCollection" />
- <seealso cref="T:Aspose.Words.Settings.Odso" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Settings.OdsoFieldMapData.Clone">
- <summary>
- Returns a deep clone of this object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.OdsoFieldMapData.Column">
- <summary>
- Specifies the zero-based index of the column within an external data source which shall be
- mapped to the local name of a specific MERGEFIELD field.
- The default value is 0.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.OdsoFieldMapData.MappedName">
- <summary>
- Specifies the predefined merge field name which shall be mapped to the column number
- specified by the <see cref="P:Aspose.Words.Settings.OdsoFieldMapData.Column" /> property within this field mapping.
- The default value is an empty string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.OdsoFieldMapData.Name">
- <summary>
- Specifies the column name within an external data source for the column whose
- index is specified by the <see cref="P:Aspose.Words.Settings.OdsoFieldMapData.Column" /> property.
- The default value is an empty string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.OdsoFieldMapData.Type">
- <summary>
- Specifies if a given mail merge field has been mapped to a column in the given external data source or not.
- The default value is <see cref="F:Aspose.Words.Settings.OdsoFieldMappingType.Default" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.OdsoFieldMapDataCollection">
- <summary>
- A typed collection of the <see cref="T:Aspose.Words.Settings.OdsoFieldMapData" /> objects.
- </summary>
- <seealso cref="T:Aspose.Words.Settings.OdsoFieldMapData" />
- <seealso cref="P:Aspose.Words.Settings.Odso.FieldMapDatas" />
- </member>
- <member name="M:Aspose.Words.Settings.OdsoFieldMapDataCollection.GetEnumerator">
- <summary>
- Returns an enumerator object that can be used to iterate over all items in the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Settings.OdsoFieldMapDataCollection.Add(Aspose.Words.Settings.OdsoFieldMapData)">
- <summary>
- Adds an object to the end of this collection.
- </summary>
- <param name="value">The object to add. Cannot be null.</param>
- </member>
- <member name="M:Aspose.Words.Settings.OdsoFieldMapDataCollection.Clear">
- <summary>
- Removes all elements from this collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Settings.OdsoFieldMapDataCollection.RemoveAt(System.Int32)">
- <summary>
- Removes the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element.</param>
- </member>
- <member name="P:Aspose.Words.Settings.OdsoFieldMapDataCollection.Count">
- <summary>
- Gets the number of elements contained in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.OdsoFieldMapDataCollection.Item(System.Int32)">
- <summary>
- Gets or sets an item in this collection.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.OdsoFieldMappingType">
- <summary>
- 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.
- </summary>
- <seealso cref="P:Aspose.Words.Settings.OdsoFieldMapData.Type" />
- </member>
- <member name="F:Aspose.Words.Settings.OdsoFieldMappingType.Column">
- <summary>
- Specifies that the mail merge field has been mapped to a column in the given external data source.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.OdsoFieldMappingType.Null">
- <summary>
- Specifies that the mail merge field has not been mapped to a column in the given external data source.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.OdsoFieldMappingType.Default">
- <summary>
- Equals to <see cref="F:Aspose.Words.Settings.OdsoFieldMappingType.Null" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.Odso">
- <summary>
- Specifies the Office Data Source Object (ODSO) settings for a mail merge data source.
- </summary>
- <remarks>
- <para>ODSO seems to be the "new" way the newer Microsoft Word versions prefer to use when specifying certain
- types of data sources for a mail merge document. ODSO probably first appeared in Microsoft Word 2000.</para>
- <para>The use of ODSO is poorly documented and the best way to learn how to use the properies of this object
- is to create a document with a desired data source manually in Microsoft Word and then open that document using
- Aspose.Words and examine the properties of the <see cref="P:Aspose.Words.Document.MailMergeSettings" /> and
- <see cref="P:Aspose.Words.Settings.MailMergeSettings.Odso" /> objects. This is a good approach to take if you want to learn how to
- programmatically configure a data source, for example.</para>
- <para>You do not normally need to create objects of this class directly because ODSO settings
- are always available via the <see cref="P:Aspose.Words.Settings.MailMergeSettings.Odso" /> property.</para>
- <seealso cref="P:Aspose.Words.Settings.MailMergeSettings.Odso" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Settings.Odso.Clone">
- <summary>
- Returns a deep clone of this object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.Odso.ColumnDelimiter">
- <summary>
- Specifies the character which shall be interpreted as the column delimiter used to separate columns within external data sources.
- The default value is 0 which means there is no column delimiter defined.
- </summary>
- <remarks>
- <para>RK I have never seen this in use.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Settings.Odso.FirstRowContainsColumnNames">
- <summary>
- Specifies that a hosting application shall treat the first row of data in the specified external data
- source as a header row containing the names of each column in the data source.
- The default value is <c>false</c>.
- </summary>
- <remarks>
- <para>RK I have never seen this in use.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Settings.Odso.DataSource">
- <summary>
- Specifies the location of the external data source to be connected to a document to perform the mail merge.
- The default value is an empty string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.Odso.TableName">
- <summary>
- Specifies the particular set of data that a source shall be connected to within an external data source.
- The default value is an empty string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.Odso.DataSourceType">
- <summary>
- Specifies the type of the external data source to be connected to as part of the ODSO connection information for this mail merge.
- The default value is <see cref="F:Aspose.Words.Settings.OdsoDataSourceType.Default" />.
- </summary>
- <remarks>
- <para>This setting is purely a suggestion of the data source type that is being used for this mail merge.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Settings.Odso.UdlConnectString">
- <summary>
- Specifies the Universal Data Link (UDL) connection string used to connect to an external data source.
- The default value is an empty string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.Odso.FieldMapDatas">
- <summary>
- Gets or sets a collection of objects that specify how columns from the external data source
- are mapped to the predefined merge field names in the document.
- This object is never null.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.Odso.RecipientDatas">
- <summary>
- Gets or sets a collection of objects that specify inclusion/exclusion of individual records in the mail merge.
- This object is never null.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.OdsoRecipientData">
- <summary>
- Represents information about a single record within an external data source that is to be excluded from the mail merge.
- </summary>
- <remarks>
- <para>If a record shall be merged into a merged document, then no information is needed about that record.
- However, if a given record shall not be merged into a merged document, then the value of the unique key
- for that record shall be stored in the <see cref="P:Aspose.Words.Settings.OdsoRecipientData.UniqueTag" /> property of this object to indicate this exclusion.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Settings.OdsoRecipientData.Clone">
- <summary>
- Returns a deep clone of this object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.OdsoRecipientData.Active">
- <summary>
- Specifies whether the record from the data source shall be imported into a document when the mail merge is performed.
- The default value is <c>true</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.OdsoRecipientData.Column">
- <summary>
- Specifies the column within the data source that contains unique data for the current record.
- The default value is 0.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.OdsoRecipientData.UniqueTag">
- <summary>
- Specifies the contents of a given record in the column containing unique data.
- The default value is <c>null</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.OdsoRecipientData.Hash">
- <summary>
- Represents the hash code for this record.
- Sometimes Microsoft Word uses <see cref="P:Aspose.Words.Settings.OdsoRecipientData.Hash" /> of a whole record instead of a <see cref="P:Aspose.Words.Settings.OdsoRecipientData.UniqueTag" /> value.
- The default value is 0.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.OdsoRecipientDataCollection">
- <summary>
- A typed collection of <see cref="T:Aspose.Words.Settings.OdsoRecipientData" /></summary>
- <remarks>
- <seealso cref="T:Aspose.Words.Settings.OdsoRecipientData" />
- <seealso cref="P:Aspose.Words.Settings.Odso.RecipientDatas" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Settings.OdsoRecipientDataCollection.GetEnumerator">
- <summary>
- Returns an enumerator object that can be used to iterate over all items in the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Settings.OdsoRecipientDataCollection.Add(Aspose.Words.Settings.OdsoRecipientData)">
- <summary>
- Adds an object to the end of this collection.
- </summary>
- <param name="value">The object to add. Cannot be null.</param>
- </member>
- <member name="M:Aspose.Words.Settings.OdsoRecipientDataCollection.Clear">
- <summary>
- Removes all elements from this collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Settings.OdsoRecipientDataCollection.RemoveAt(System.Int32)">
- <summary>
- Removes the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element.</param>
- </member>
- <member name="P:Aspose.Words.Settings.OdsoRecipientDataCollection.Count">
- <summary>
- Gets the number of elements contained in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.OdsoRecipientDataCollection.Item(System.Int32)">
- <summary>
- Gets or sets an item in this collection.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.CompatibilityOptions">
- <summary>
- Contains compatibility options (that is, the user preferences entered on the <b>Compatibility</b>
- tab of the <b>Options</b> dialog in Microsoft Word).
- </summary>
- <seealso cref="T:Aspose.Words.Document" />
- <seealso cref="P:Aspose.Words.Document.CompatibilityOptions" />
- </member>
- <member name="M:Aspose.Words.Settings.CompatibilityOptions.OptimizeFor(Aspose.Words.Settings.MsWordVersion)">
- <summary>
- <para>Allows to optimize the document contents as well as default Aspose.Words behavior to a particular versions of MS Word.</para>
- <para>Use this method to prevent MS Word from displaying "Compatibility mode" ribbon upon document loading.
- (Note that you may also need to set the <see cref="P:Aspose.Words.Saving.OoxmlSaveOptions.Compliance" /> property to
- <see cref="F:Aspose.Words.Saving.OoxmlCompliance.Iso29500_2008_Transitional" /> or higher.)
- </para>
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.NoTabHangInd">
- <summary>
- Do Not Create Custom Tab Stop for Hanging Indent.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.NoSpaceRaiseLower">
- <summary>
- Do Not Increase Line Height for Raised/Lowered Text.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.SuppressSpBfAfterPgBrk">
- <summary>
- Do Not Use Space Before On First Line After a Page Break.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.WrapTrailSpaces">
- <summary>
- Line Wrap Trailing Spaces.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.PrintColBlack">
- <summary>
- Print Colors as Black And White without Dithering.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.NoColumnBalance">
- <summary>
- Do Not Balance Text Columns within a Section.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.ConvMailMergeEsc">
- <summary>
- Treat Backslash Quotation Delimiter as Two Quotation Marks.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.SuppressTopSpacing">
- <summary>
- Ignore Minimum and Exact Line Height for First Line on Page.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.UseSingleBorderforContiguousCells">
- <summary>
- Use Simplified Rules For Table Border Conflicts.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.TransparentMetafiles">
- <summary>
- Specifies not to blank the area behind metafile pictures.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.ShowBreaksInFrames">
- <summary>
- Display Page/Column Breaks Present in Frames.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.SwapBordersFacingPgs">
- <summary>
- Swap Paragraph Borders on Odd Numbered Pages.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DoNotLeaveBackslashAlone">
- <summary>
- Convert Backslash To Yen Sign When Entered.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DoNotExpandShiftReturn">
- <summary>
- Don't Justify Lines Ending in Soft Line Break.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.UlTrailSpace">
- <summary>
- Underline All Trailing Spaces.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.BalanceSingleByteDoubleByteWidth">
- <summary>
- Balance Single Byte and Double Byte Characters.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.SuppressSpacingAtTopOfPage">
- <summary>
- Ignore Minimum Line Height for First Line on Page.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.SpacingInWholePoints">
- <summary>
- Only Expand/Condense Text By Whole Points.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.PrintBodyTextBeforeHeader">
- <summary>
- Print Body Text before Header/Footer Contents.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.NoLeading">
- <summary>
- Do Not Add Leading Between Lines of Text.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.SpaceForUL">
- <summary>
- Add Additional Space Below Baseline For Underlined East Asian Text.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.MWSmallCaps">
- <summary>
- Emulate Word 5.x for the Macintosh Small Caps Formatting.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.SuppressTopSpacingWP">
- <summary>
- Emulate WordPerfect 5.x Line Spacing.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.TruncateFontHeightsLikeWP6">
- <summary>
- Emulate WordPerfect 6.x Font Height Calculation.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.SubFontBySize">
- <summary>
- Increase Priority Of Font Size During Font Substitution.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.LineWrapLikeWord6">
- <summary>
- Emulate Word 6.0 Line Wrapping for East Asian Text.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DoNotSuppressParagraphBorders">
- <summary>
- Do Not Suppress Paragraph Borders Next To Frames.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.NoExtraLineSpacing">
- <summary>
- Do Not Center Content on Lines With Exact Line Height.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.SuppressBottomSpacing">
- <summary>
- Ignore Exact Line Height for Last Line on Page.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.WPSpaceWidth">
- <summary>
- Specifies whether to set the width of a space as is done in WordPerfect 5.x.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.WPJustification">
- <summary>
- Emulate WordPerfect 6.x Paragraph Justification.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.UsePrinterMetrics">
- <summary>
- Use Printer Metrics To Display Documents.
- </summary>
- <remarks>
- Printer Metrics may differ depending on drivers used.
- For instance, Windows "Microsoft OpenXPS Class Driver 2" and "Microsoft Print to PDF" provide slightly different metrics.
- Therefore, the final document's layout may change if this option is enabled.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.ShapeLayoutLikeWW8">
- <summary>
- Emulate Word 97 Text Wrapping Around Floating Objects.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.FootnoteLayoutLikeWW8">
- <summary>
- Emulate Word 6.x/95/97 Footnote Placement.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DoNotUseHTMLParagraphAutoSpacing">
- <summary>
- Use Fixed Paragraph Spacing for HTML Auto Setting.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.AdjustLineHeightInTable">
- <summary>
- Add Document Grid Line Pitch To Lines in Table Cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.ForgetLastTabAlignment">
- <summary>
- Ignore Width of Last Tab Stop When Aligning Paragraph If It Is Not Left Aligned.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.AutoSpaceLikeWord95">
- <summary>
- Emulate Word 95 Full-Width Character Spacing.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.AlignTablesRowByRow">
- <summary>
- Align Table Rows Independently.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.LayoutRawTableWidth">
- <summary>
- Ignore Space Before Table When Deciding If Table Should Wrap Floating Object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.LayoutTableRowsApart">
- <summary>
- Allow Table Rows to Wrap Inline Objects Independently.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.UseWord97LineBreakRules">
- <summary>
- Emulate Word 97 East Asian Line Breaking.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DoNotBreakWrappedTables">
- <summary>
- Do Not Allow Floating Tables To Break Across Pages.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DoNotSnapToGridInCell">
- <summary>
- Do Not Snap to Document Grid in Table Cells with Objects.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.SelectFldWithFirstOrLastChar">
- <summary>
- Select Field When First or Last Character Is Selected.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.ApplyBreakingRules">
- <summary>
- Use Legacy Ethiopic and Amharic Line Breaking Rules.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DoNotWrapTextWithPunct">
- <summary>
- Do Not Allow Hanging Punctuation With Character Grid.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DoNotUseEastAsianBreakRules">
- <summary>
- Do Not Compress Compressible Characters When Using Document Grid.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.UseWord2002TableStyleRules">
- <summary>
- Emulate Word 2002 Table Style Rules.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.GrowAutofit">
- <summary>
- Allow Tables to AutoFit Into Page Margins.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.UseNormalStyleForList">
- <summary>
- Do Not Automatically Apply List Paragraph Style To Bulleted/Numbered Text.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DoNotUseIndentAsNumberingTabStop">
- <summary>
- Ignore Hanging Indent When Creating Tab Stop After Numbering.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.UseAltKinsokuLineBreakRules">
- <summary>
- Use Alternate Set of East Asian Line Breaking Rules.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.AllowSpaceOfSameStyleInTable">
- <summary>
- Allow Contextual Spacing of Paragraphs in Tables.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DoNotSuppressIndentation">
- <summary>
- Do Not Ignore Floating Objects When Calculating Paragraph Indentation.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DoNotAutofitConstrainedTables">
- <summary>
- Do Not AutoFit Tables To Fit Next To Wrapped Objects.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.AutofitToFirstFixedWidthCell">
- <summary>
- Allow Table Columns To Exceed Preferred Widths of Constituent Cells.
- </summary>
- <remarks>
- The option is called "Use Word 2003 table autofit rules" in MS Word 2013 user interface.
- It actually affects how the grid is calculated for fixed layout tables, too (for some cases).
- </remarks>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.UnderlineTabInNumList">
- <summary>
- Underline Following Character Following Numbering.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DisplayHangulFixedWidth">
- <summary>
- Always Use Fixed Width for Hangul Characters.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.SplitPgBreakAndParaMark">
- <summary>
- Always Move Paragraph Mark to Page after a Page Break.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DoNotVertAlignCellWithSp">
- <summary>
- Don't Vertically Align Cells Containing Floating Objects.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DoNotBreakConstrainedForcedTable">
- <summary>
- Don't Break Table Rows Around Floating Tables.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.DoNotVertAlignInTxbx">
- <summary>
- Ignore Vertical Alignment in Textboxes.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.UseAnsiKerningPairs">
- <summary>
- Use ANSI Kerning Pairs from Fonts.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.CachedColBalance">
- <summary>
- Use Cached Paragraph Information for Column Balancing.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.UseFELayout">
- <summary>
- Do Not Bypass East Asian/Complex Script Layout Code.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.OverrideTableStyleFontSizeAndJustification">
- <summary>
- Specifies how the style hierarchy of the document is evaluated.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.CompatibilityOptions.UICompat97To2003">
- <summary>
- <b>True</b> to disable UI functionality which is not compatible with Word97-2003.
- Default value is <b>false</b>.
- </summary>
- <remarks>
- Controls the Word97-2003 compatibility setting that disables UI functionality which
- is not compatible with Word97-2003.
- When <b>true</b>, 'w:uiCompat97To2003' XML element is written to '\word\settings.xml'
- document package part.
- Default value is <b>false</b>. When set to <b>false</b>, this element is not written.
-
- Technically this property is not part of compatibility options, but we have put it here for API convenience.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Settings.MailMergeDataType">
- <summary>
- Specifies the type of an external mail merge data source.
- </summary>
- <seealso cref="P:Aspose.Words.Settings.MailMergeSettings.DataType" />
- <dev>Do not renumber these values as they are used in the DOC codec.</dev>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeDataType.None">
- <summary>
- No mail merge data source is specified.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeDataType.TextFile">
- <summary>
- Specifies that a given document has been connected to a text file via the Dynamic Data Exchange (DDE) system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeDataType.Database">
- <summary>
- Specifies that a given document has been connected to an Access database via the Dynamic Data Exchange (DDE) system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeDataType.Spreadsheet">
- <summary>
- Specifies that a given document has been connected to an Excel spreadsheet via the Dynamic Data Exchange (DDE) system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeDataType.Query">
- <summary>
- Specifies that a given document has been connected to an external data source using an external query tool.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeDataType.Odbc">
- <summary>
- Specifies that a given document has been connected to an external data source via the Open Database Connectivity interface.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeDataType.Native">
- <summary>
- Specifies that a given document has been connected to an external data source via the Office Data Source Object (ODSO) interface.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeDataType.Default">
- <summary>
- Equals to <see cref="F:Aspose.Words.Settings.MailMergeDataType.None" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.MailMergeDestination">
- <summary>
- Specifies the possible results which may be generated when a mail merge is carried out on a document.
- </summary>
- <seealso cref="P:Aspose.Words.Settings.MailMergeSettings.Destination" />
- <dev>Do not renumber these as they values are used in the DOC codec.</dev>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeDestination.NewDocument">
- <summary>
- Specifies that conforming hosting applications shall generate new documents by populating the fields
- within a given document with data from the specified external data source.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeDestination.Printer">
- <summary>
- Specifies that conforming hosting applications shall print the documents that result from populating the
- fields within a given document with external data from the specified external data source.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeDestination.Email">
- <summary>
- Specifies that conforming hosting applications shall generate emails using the documents that result from
- populating the fields within a given document with data from the specified external data source.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeDestination.Fax">
- <summary>
- Specifies that conforming hosting applications shall generate faxes using the documents that result from
- populating the fields within a given document with data from the specified external data source.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeDestination.Default">
- <summary>
- Equals to the <see cref="F:Aspose.Words.Settings.MailMergeDestination.NewDocument" /> value.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.MailMergeMainDocumentType">
- <summary>
- Specifies the possible types for a mail merge source document.
- </summary>
- <seealso cref="P:Aspose.Words.Settings.MailMergeSettings.MainDocumentType" />
- <dev>Do not renumber these because the values are used in the DOC codec.</dev>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeMainDocumentType.NotAMergeDocument">
- <summary>
- This document is not a mail merge document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeMainDocumentType.FormLetters">
- <summary>
- Specifies that the mail merge source document is of the form letter type.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeMainDocumentType.MailingLabels">
- <summary>
- Specifies that the mail merge source document is of the mailing label type.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeMainDocumentType.Envelopes">
- <summary>
- Specifies that the mail merge source document is of the envelope type.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeMainDocumentType.Catalog">
- <summary>
- Specifies that the mail merge source document is of the catalog type.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeMainDocumentType.Email">
- <summary>
- Specifies that the mail merge source document is of the e-mail message type.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeMainDocumentType.Fax">
- <summary>
- Specifies that the mail merge source document is of the fax type.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.MailMergeMainDocumentType.Default">
- <summary>
- Equals to <see cref="F:Aspose.Words.Settings.MailMergeMainDocumentType.NotAMergeDocument" /></summary>
- </member>
- <member name="T:Aspose.Words.Settings.MailMergeSettings">
- <summary>
- Specifies all of the mail merge information for a document.
- </summary>
- <remarks>
- <para>You can use this object to specify a mail merge data source for a document and this information
- (along with the available data fields) will appear in Microsoft Word when the user opens this document.
- Or you can use this object to query mail merge settings that the user has specified in Microsoft Word
- for this document.</para>
- <para>You do not normally need to create objects of this class directly because Mail merge settings
- of a document are always available via the <see cref="P:Aspose.Words.Document.MailMergeSettings" /> property.</para>
- <para>To detect whether this document is a mail merge main document, check the value of the
- <see cref="P:Aspose.Words.Settings.MailMergeSettings.MainDocumentType" /> property.</para>
- <para>To remove mail merge settings and data source information from a document you can use the
- <see cref="M:Aspose.Words.Settings.MailMergeSettings.Clear" /> method. Aspose.Words will not write mail merge settings to a document if
- the <see cref="P:Aspose.Words.Settings.MailMergeSettings.MainDocumentType" /> property is set to <see cref="F:Aspose.Words.Settings.MailMergeMainDocumentType.NotAMergeDocument" />
- or the <see cref="P:Aspose.Words.Settings.MailMergeSettings.DataType" /> property is set to <see cref="F:Aspose.Words.Settings.MailMergeDataType.None" />.</para>
- <para>The best way to learn how to use the properties of this object is to create a document with a desired
- data source manually in Microsoft Word and then open that document using Aspose.Words and examine the properties
- of the <see cref="P:Aspose.Words.Document.MailMergeSettings" /> and <see cref="P:Aspose.Words.Settings.MailMergeSettings.Odso" /> objects. This is
- a good approach to take if you want to learn how to programmatically configure a data source, for example.</para>
- <para>Aspose.Words preserves mail merge information when loading, saving and converting documents
- between different formats, but does not use this information when performing its own mail merge
- using the <see cref="T:Aspose.Words.MailMerging.MailMerge" /> object.</para>
- <seealso cref="P:Aspose.Words.Document.MailMergeSettings" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Settings.MailMergeSettings.Clear">
- <summary>
- Clears the mail merge settings in such a way that when the document is saved,
- no mail merge settings will be saved and it will become a normal document.
- </summary>
- </member>
- <member name="M:Aspose.Words.Settings.MailMergeSettings.Clone">
- <summary>
- Returns a deep clone of this object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.ActiveRecord">
- <summary>
- Specifies the one-based index of the record from the data source which shall be displayed in Microsoft Word. The default value is 1.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.AddressFieldName">
- <summary>
- Specifies the column within the data source that contains e-mail addresses. The default value is an empty string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.CheckErrors">
- <summary>
- Specifies the type of error reporting which shall be conducted by Microsoft Word when performing a mail merge.
- The default value is <see cref="F:Aspose.Words.Settings.MailMergeCheckErrors.Default" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.ConnectString">
- <summary>
- Specifies the connection string used to connect to an external data source. The default value is an empty string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.DataSource">
- <summary>
- Specifies the path to the mail-merge data source. The default value is an empty string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.DataType">
- <summary>
- Specifies the type of the mail-merge data source and the method of data access.
- The default value is <see cref="F:Aspose.Words.Settings.MailMergeDataType.Default" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.Destination">
- <summary>
- Specifies how Microsoft Word will output the results of a mail merge.
- The default value is <see cref="F:Aspose.Words.Settings.MailMergeDestination.Default" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.DoNotSupressBlankLines">
- <summary>
- Specifies how an application performing the mail merge shall handle blank lines in the merged documents resulting from the mail merge.
- The default value is <c>false</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.HeaderSource">
- <summary>
- Specifies the path to the mail-merge header source.
- The default value is an empty string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.LinkToQuery">
- <summary>
- Not sure about this one.
- The Microsoft Word Automation Reference suggests that this specifies that the query is executed every time the document
- is opened in Microsoft Word. But the OOXML specification suggests that this specifies that the query contains a reference
- to an external query file which contains the actual query.
- The default value is <c>false</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.MailAsAttachment">
- <summary>
- Specifies that the documents produced during a mail merge operation should be emailed as an attachment rather
- than the body of the actual e-mail. The default value is <c>false</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.MailSubject">
- <summary>
- Specifies the text which shall appear in the subject line of the e-mails or faxes produced during mail merge.
- The default value is an empty string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.MainDocumentType">
- <summary>
- Specifies the mail-merge main document type.
- The default value is <see cref="F:Aspose.Words.Settings.MailMergeMainDocumentType.Default" />.
- </summary>
- <remarks>
- <para>The main document is the document that contains information that is the same for each version of the merged document.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.Odso">
- <summary>
- Gets or sets the object that specifies the Office Data Source Object (ODSO) settings.
- </summary>
- <remarks>
- <para>This object is never null.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.Query">
- <summary>
- Contains the Structured Query Language string that shall be run against the specified external data source to
- return the set of records which shall be imported into the document when the mail merge operation is performed.
- The default value is an empty string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.MailMergeSettings.ViewMergedData">
- <summary>
- Specifies that Microsoft Word shall display the data from the specified external data source where merge fields
- have been inserted (e.g. preview merged data). The default value is <c>false</c>.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.WriteProtection">
- <summary>
- Specifies write protection settings for a document.
- </summary>
- <remarks>
- <para>Write protection specifies whether the author has recommended that
- the document is to be opened as read-only and/or require a password to modify a document.</para>
- <para>Write protection is different from document protection. Write protection is specified in
- Microsoft Word in the options of the Save As dialog box.</para>
- <para>You do not create instances of this class directly. You access document protection settings
- via the <see cref="P:Aspose.Words.Document.WriteProtection" /> property.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Settings.WriteProtection.SetPassword(System.String)">
- <summary>
- Sets the write protection password for the document.
- </summary>
- <remarks>
- <para>If a password is set, Microsoft Word will require the user to enter it or open
- the document as read-only.</para>
- </remarks>
- <param name="password">The password to set. Cannot be null, but can be an empty string.</param>
- </member>
- <member name="M:Aspose.Words.Settings.WriteProtection.ValidatePassword(System.String)">
- <summary>
- Returns true if the specified password is the same as the write-protection password the document was protected with.
- If document is not write-protected with password then returns false.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.WriteProtection.ReadOnlyRecommended">
- <summary>
- Specifies whether the document author has recommended that the document be opened as read-only.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.WriteProtection.IsWriteProtected">
- <summary>
- Returns true when a write protection password is set.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.ViewOptions">
- <summary>
- Provides various options that control how a document is shown in Microsoft Word.
- </summary>
- <seealso cref="T:Aspose.Words.Document" />
- <seealso cref="P:Aspose.Words.Document.ViewOptions" />
- </member>
- <member name="P:Aspose.Words.Settings.ViewOptions.ViewType">
- <summary>
- Controls the view mode in Microsoft Word.
- </summary>
- <remarks>
- <p>Although Aspose.Words is able to read and write this option, its usage is application-specific.
- For example MS Word 2013 does not respect the value of this option.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Settings.ViewOptions.ZoomType">
- <summary>
- Gets or sets a zoom value based on the size of the window.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.ViewOptions.ZoomPercent">
- <summary>
- Gets or sets the percentage (between 10 and 500) at which you want to view your document.
- </summary>
- <remarks>
- <p>If value is 0 then this property uses 100 instead, else if value is less than 10 or greater
- than 500 this property throws.</p>
- <p>Although Aspose.Words is able to read and write this option, its usage is application-specific.
- For example MS Word 2013 does not respect the value of this option.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Settings.ViewOptions.DoNotDisplayPageBoundaries">
- <summary>
- Turns off display of the space between the top of the text and the top edge of the page.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.ViewOptions.DisplayBackgroundShape">
- <summary>
- Controls display of the background shape in print layout view.
- </summary>
- </member>
- <member name="P:Aspose.Words.Settings.ViewOptions.FormsDesign">
- <summary>
- Specifies whether the document is in forms design mode.
- </summary>
- <remarks>
- <p>Currently works only for documents in WordML format.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Settings.ViewType">
- <summary>
- Possible values for the view mode in Microsoft Word.
- </summary>
- <seealso cref="T:Aspose.Words.Settings.ViewOptions" />
- <seealso cref="P:Aspose.Words.Settings.ViewOptions.ViewType" />
- </member>
- <member name="F:Aspose.Words.Settings.ViewType.None">
- <summary>
- The document shall be rendered in the default view of the application.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.ViewType.Reading">
- <summary>
- The document shall be rendered in the default view of the application.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.ViewType.PageLayout">
- <summary>
- The document shall be opened in a view that displays the document as it will print.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.ViewType.Outline">
- <summary>
- The document shall be rendered in a view optimized for outlining or creating long documents.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.ViewType.Normal">
- <summary>
- The document shall be rendered in a view optimized for outlining or creating long documents.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.ViewType.Web">
- <summary>
- The document shall be rendered in a view mimicking the way this document would be displayed
- in a web page.
- </summary>
- </member>
- <member name="T:Aspose.Words.Settings.ZoomType">
- <summary>
- Possible values for how large or small the document appears on the screen in Microsoft Word.
- </summary>
- <seealso cref="T:Aspose.Words.Settings.ViewOptions" />
- <seealso cref="P:Aspose.Words.Settings.ViewOptions.ZoomType" />
- </member>
- <member name="F:Aspose.Words.Settings.ZoomType.Custom">
- <summary>
- Zoom percentage is set explicitly. It is not recalculated automatically when control size changes.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.ZoomType.None">
- <summary>
- Indicates to use the explicit zoom percentage. Same as <see cref="F:Aspose.Words.Settings.ZoomType.Custom" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.ZoomType.FullPage">
- <summary>
- Zoom percentage is automatically recalculated to fit one full page.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.ZoomType.PageWidth">
- <summary>
- Zoom percentage is automatically recalculated to fit page width.
- </summary>
- </member>
- <member name="F:Aspose.Words.Settings.ZoomType.TextFit">
- <summary>
- Zoom percentage is automatically recalculated to fit text.
- </summary>
- </member>
- <member name="T:Aspose.Words.MailMerging.MailMergeRegionInfo">
- <summary>
- Contains information about a mail merge region.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMergeRegionInfo.Regions">
- <summary>
- Returns a list of child regions.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMergeRegionInfo.Fields">
- <summary>
- Returns a list of child fields.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMergeRegionInfo.Name">
- <summary>
- Returns the name of region.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMergeRegionInfo.StartField">
- <summary>
- Returns a start field for the region.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMergeRegionInfo.EndField">
- <summary>
- Returns an end field for the region.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMergeRegionInfo.Level">
- <summary>
- Returns the nesting level for the region.
- </summary>
- </member>
- <member name="T:Aspose.Words.MailMerging.IMailMergeCallback">
- <summary>
- Implement this interface if you want to receive notifications while mail merge is performed.
- </summary>
- </member>
- <member name="M:Aspose.Words.MailMerging.IMailMergeCallback.TagsReplaced">
- <summary>
- Called when "mustache" text tags are replaced with MERGEFIELD fields.
- </summary>
- <seealso cref="P:Aspose.Words.MailMerging.MailMerge.UseNonMergeFields" />
- </member>
- <member name="T:Aspose.Words.MailMerging.MailMergeCleanupOptions">
- <summary>
- Specifies options that determine what items are removed during mail merge.
- </summary>
- </member>
- <member name="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.None">
- <summary>
- Specifies a default value.
- </summary>
- </member>
- <member name="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveEmptyParagraphs">
- <summary>
- Specifies whether paragraphs that contained mail merge fields with no data should be removed from the document.
- When this option is set, paragraphs which contain region start and end merge fields which are otherwise empty
- are also removed.
- </summary>
- </member>
- <member name="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveUnusedRegions">
- <summary>
- Specifies whether unused mail merge regions should be removed from the document.
- </summary>
- <remarks>
- This option applies only to mail merge with regions.
- </remarks>
- </member>
- <member name="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveUnusedFields">
- <summary>
- Specifies whether unused merge fields should be removed from the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveContainingFields">
- <summary>
- Specifies whether fields that contain merge fields (for example, IFs) should be removed from the document
- if the nested merge fields are removed.
- </summary>
- </member>
- <member name="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveStaticFields">
- <summary>
- Specifies whether static fields should be removed from the document. Static fields are fields, which
- results remain the same upon any document change. Fields, which do not store their results in a document
- and are calculated on the fly (like <see cref="F:Aspose.Words.Fields.FieldType.FieldListNum" />,
- <see cref="F:Aspose.Words.Fields.FieldType.FieldSymbol" />, etc.) are not considered to be static.
- </summary>
- <remarks>
- Here is the full list of field types, which are not considered to be static:
- <list type="bullet"><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldAdvance" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldAutoNum" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldAutoNumLegal" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldAutoNumOutline" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldBarcode" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldBidiOutline" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldDate" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldDisplayBarcode" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldMergeBarcode" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldFormCheckBox" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldFormDropDown" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldFormula" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldGoToButton" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldHyperlink" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldIncludeText" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldIndexEntry" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldLink" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldListNum" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldMacroButton" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldNoteRef" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldNumPages" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldPage" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldPageRef" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldPrint" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldPrintDate" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldPrivate" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldRefDoc" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldSection" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldSectionPages" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldSymbol" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldTime" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldTOAEntry" /></description></item><item><description><see cref="F:Aspose.Words.Fields.FieldType.FieldTOCEntry" /></description></item></list></remarks>
- </member>
- <member name="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveEmptyTableRows">
- <summary>
- Specifies whether empty rows that contain mail merge regions should be removed from the document.
- </summary>
- <remarks>
- This option applies only to mail merge with regions.
- </remarks>
- </member>
- <member name="T:Aspose.Words.MailMerging.IMailMergeDataSourceRoot">
- <summary>
- Implement this interface to allow mail merge from a custom data source with master-detail data.
- </summary>
- </member>
- <member name="M:Aspose.Words.MailMerging.IMailMergeDataSourceRoot.GetDataSource(System.String)">
- <summary>
- The Aspose.Words mail merge engine invokes this method when it encounters a beginning of a top-level mail merge region.
- </summary>
- <remarks>
- <para>
- When the Aspose.Words mail merge engines populates a document with data and encounters MERGEFIELD TableStart:TableName,
- it invokes <see cref="M:Aspose.Words.MailMerging.IMailMergeDataSourceRoot.GetDataSource(System.String)" /> on this object. Your implementation needs to return a new data source object.
- Aspose.Words will use the returned data source to populate the mail merge region.
- </para>
- <para>
- If a data source (table) with the specified name does not exist, your implementation should return <c>null</c>.
- </para>
- </remarks>
- <param name="tableName">The name of the mail merge region as specified in the template document. Case-insensitive.</param>
- <returns>A data source object that will provide access to the data records of the specified table.</returns>
- </member>
- <member name="T:Aspose.Words.MailMerging.IMailMergeDataSource">
- <summary>
- Implement this interface to allow mail merge from a custom data source, such as a list of objects. Master-detail data is also supported.
- </summary>
- <remarks>
- <para>When a data source is created, it should be initialized to point to BOF (before the first record).
- The Aspose.Words mail merge engine will invoke <see cref="M:Aspose.Words.MailMerging.IMailMergeDataSource.MoveNext" /> to advance to next record and
- then invoke <see cref="M:Aspose.Words.MailMerging.IMailMergeDataSource.GetValue(System.String,System.Object@)" /> for every merge field it encounters in the document or the current mail merge region.</para>
- <seealso cref="T:Aspose.Words.MailMerging.MailMerge" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.MailMerging.IMailMergeDataSource.MoveNext">
- <summary>
- Advances to the next record in the data source.
- </summary>
- <returns>True if moved to next record successfully. False if reached end of the data source.</returns>
- </member>
- <member name="M:Aspose.Words.MailMerging.IMailMergeDataSource.GetValue(System.String,System.Object@)">
- <summary>
- Returns a value for the specified field name or false if the field is not found.
- </summary>
- <param name="fieldName">The name of the data field.</param>
- <param name="fieldValue">Returns the field value.</param>
- <returns>
- <b>true</b> if value was found.</returns>
- </member>
- <member name="M:Aspose.Words.MailMerging.IMailMergeDataSource.GetChildDataSource(System.String)">
- <summary>
- The Aspose.Words mail merge engine invokes this method when it encounters a beginning of a nested mail merge region.
- </summary>
- <remarks>
- <para>
- When the Aspose.Words mail merge engines populates a mail merge region with data and encounters the beginning of a nested
- mail merge region in the form of MERGEFIELD TableStart:TableName, it invokes <see cref="M:Aspose.Words.MailMerging.IMailMergeDataSource.GetChildDataSource(System.String)" /> on the current
- data source object. Your implementation needs to return a new data source object that will provide access to the child
- records of the current parent record. Aspose.Words will use the returned data source to populate the nested mail merge region.
- </para>
- <para>
- Below are the rules that the implementation of <see cref="M:Aspose.Words.MailMerging.IMailMergeDataSource.GetChildDataSource(System.String)" /> must follow.
- </para>
- <para>
- If the table that is represented by this data source object has a related child (detail) table with the specified name,
- then your implementation needs to return a new <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSource" /> object that will provide access
- to the child records of the current record.
-
- An example of this is Orders / OrderDetails relationship. Let's assume that the current <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSource" /> object
- represents the Orders table and it has a current order record. Next, Aspose.Words encounters "MERGEFIELD TableStart:OrderDetails"
- in the document and invokes <see cref="M:Aspose.Words.MailMerging.IMailMergeDataSource.GetChildDataSource(System.String)" />. You need to create and return a <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSource" />
- object that will allow Aspose.Words to access the OrderDetails record for the current order.
- </para>
- <para>
- If this data source object does not have a relation to the table with the specified name, then you need to return
- a <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSource" /> object that will provide access to all records of the specified table.
- </para>
- <para>
- If a table with the specified name does not exist, your implementation should return <c>null</c>.
- </para>
- </remarks>
- <param name="tableName">The name of the mail merge region as specified in the template document. Case-insensitive.</param>
- <returns>A data source object that will provide access to the data records of the specified table.</returns>
- </member>
- <member name="P:Aspose.Words.MailMerging.IMailMergeDataSource.TableName">
- <summary>
- Returns the name of the data source.
- </summary>
- <remarks>
- <p>If you are implementing <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSource" />, return the name of the data
- source from this property.</p>
- <p>Aspose.Words uses this name to match against the mail merge region name specified
- in the template document. The comparison between the data source name and
- the mail merge region name is not case sensitive.</p>
- </remarks>
- <returns>The name of the data source. Empty string if the data source has no name.</returns>
- </member>
- <member name="T:Aspose.Words.MailMerging.MailMerge">
- <summary>
- Represents the mail merge functionality.
- </summary>
- <remarks>
- <p>For mail merge operation to work, the document should contain Word MERGEFIELD and
- optionally NEXT fields. During mail merge operation, merge fields in the document are
- replaced with values from your data source.</p>
- <p>There are two distinct ways to use mail merge: with mail merge regions and without.</p>
- <p>The simplest mail merge is without regions and it is very similar to how mail merge
- works in Word. Use <tt>Execute</tt> methods to merge information from some
- data source such as <b>DataTable</b>, <b>DataSet</b>, <b>DataView</b>, <b>IDataReader</b>
- or an array of objects into your document. The
- <b>MailMerge</b> object processes all records of the data source and copies and appends
- content of the whole document for each record.</p>
- <p>Note that when <b>MailMerge</b> object encounters a NEXT field, it selects next record
- in the data source and continues merging without copying any content.</p>
- <p>Use <tt>ExecuteWithRegions</tt> methods to merge information into a
- document with mail merge regions defined. You can use
- <b>DataSet</b>, <b>DataTable</b>, <b>DataView</b> or <b>IDataReader</b>
- as data sources for this operation.</p>
- <p>You need to use mail merge regions if you want to dynamically grow portions inside the
- document. Without mail merge regions whole document will be repeated for every record of
- the data source.</p>
- <seealso cref="T:Aspose.Words.Document" />
- <seealso cref="P:Aspose.Words.Document.MailMerge" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.Execute(Aspose.Words.MailMerging.IMailMergeDataSource)">
- <summary>
- Performs a mail merge from a custom data source.
- </summary>
- <remarks>
- <p>Use this method to fill mail merge fields in the document with values from
- any data source such as a list or hashtable or objects. You need to write your
- own class that implements the <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSource" /> interface.</p>
- <p>You can use this method only when <see cref="P:Aspose.Words.Fields.FieldOptions.IsBidiTextSupportedOnUpdate" /> is false,
- that is you do not need Right-To-Left language (such as Arabic or Hebrew) compatibility.</p>
- <p>This method ignores the <see cref="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveUnusedRegions" /> option.</p>
- </remarks>
- <param name="dataSource">An object that implements the custom mail merge data source interface.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.Execute(Aspose.Words.MailMerging.IMailMergeDataSourceCore)">
- <summary>
- Performs a mail merge from a custom data source.
- </summary>
- <remarks>
- <p>Use this method to fill mail merge fields in the document with values from
- any data source such as a list or hashtable or objects. You need to write your
- own class that implements the <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSourceCore" /> interface.</p>
- <p>You should use this method when <see cref="P:Aspose.Words.Fields.FieldOptions.IsBidiTextSupportedOnUpdate" /> is true,
- that is when you need Right-To-Left language (such as Arabic or Hebrew) compatibility.
- There are no other benefits from using of <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSourceCore" /> instead of
- <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSource" />.</p>
- <p>This method ignores the <see cref="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveUnusedRegions" /> option.</p>
- </remarks>
- <param name="dataSource">An object that implements the custom mail merge data source interface.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.Execute(System.String[],System.Object[])">
- <overloads>Performs a mail merge operation.</overloads>
- <summary>
- Performs a mail merge operation for a single record.
- </summary>
- <remarks>
- <p>Use this method to fill mail merge fields in the document with values from
- an array of objects.</p>
- <p>This method merges data for one record only. The array of field names
- and the array of values represent the data of a single record.</p>
- <p>This method does not use mail merge regions.</p>
- <p>This method ignores the <see cref="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveUnusedRegions" /> option.</p>
- </remarks>
- <param name="fieldNames">Array of merge field names. Field names are not case sensitive.
- If a field name that is not found in the document is encountered, it is ignored.</param>
- <param name="values">Array of values to be inserted into the merge fields.
- Number of elements in this array must be the same as the number of elements in fieldNames.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.Execute(System.Data.DataTable)">
- <summary>
- Performs mail merge from a DataTable into the document.
- </summary>
- <remarks>
- <p>Use this method to fill mail merge fields in the document with values from a
- <b>DataTable</b>.</p>
- <p>All records from the table are merged into the document.</p>
- <p>You can use NEXT field in the Word document to cause <b>MailMerge</b> object to select
- next record from the <b>DataTable</b> and continue merging.
- This can be used when creating documents such as mailing labels.</p>
- <p>When <b>MailMerge</b> object reaches end of the main document and there are still more
- rows in the <b>DataTable</b>, it copies entire content of
- the main document and appends it to the end of the destination document using a section
- break as a separator.</p>
- <p>This method ignores the <see cref="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveUnusedRegions" /> option.</p>
- </remarks>
- <param name="table">Table that contains data to be inserted into mail merge fields.
- Field names are not case sensitive.
- If a field name that is not found in the document is encountered, it is ignored.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.ExecuteADO(System.Object)">
- <summary>
- Performs mail merge from an ADO Recordset object into the document.
- </summary>
- <remarks>
- <p>This method is useful when you intend to use Aspose.Words classes as
- COM objects from unmanaged code such as an application built using
- ASP or Visual Basic 6.0.</p>
- <p>This method ignores the <see cref="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveUnusedRegions" /> option.</p>
- <p>For more information see description of MailMerge.Execute(DataTable).</p>
- </remarks>
- <example>
- <code>
- [VBScript]
-
- Dim RS
- Set RS = CreateObject("ADODB.Recordset")
- RS.Open _
- "SELECT TOP 50 * FROM Customers ORDER BY Country, CompanyName", _
- "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=Northwind.mdb"
-
- Dim License
- Set License = CreateObject("Aspose.Words.License")
- License.SetLicense "C:\MyPath\MyLicense.lic"
-
- Dim Helper
- Set Helper = CreateObject("Aspose.Words.ComHelper")
- Dim Doc
- Set Doc = Helper.Open("CustomerLabels.doc")
-
- Doc.MailMerge.ExecuteADO RS
- Doc.Save "C:\MyPath\CustomerLabels Out VBScript.doc"
- </code>
- </example>
- <param name="recordset">ADO Recordset or Record object.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.Execute(System.Data.IDataReader)">
- <summary>
- Performs mail merge from IDataReader into the document.
- </summary>
- <remarks>
- <p>You can pass <b>SqlDataReader</b> or <b>OleDbDataReader</b> object into this
- method as a parameter because they both implemented <b>IDataReader</b> interface.</p>
- <p>Note this method does not use mail merge regions and for multiple records the
- document will grow by repeating the whole document.</p>
- <p>This method ignores the <see cref="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveUnusedRegions" /> option.</p>
- </remarks>
- <param name="dataReader">Data source for the mail merge operation.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.Execute(System.Data.DataView)">
- <summary>
- Performs mail merge from a DataView into the document.
- </summary>
- <remarks>
- <p>This method is useful if you retrieve data into a <b>DataTable</b> but then
- need to apply a filter or sort before the mail merge.</p>
- <p>Note this method does not use mail merge regions and for multiple records the
- document will grow by repeating the whole document.</p>
- <p>This method ignores the <see cref="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveUnusedRegions" /> option.</p>
- </remarks>
- <param name="dataView">Data source for the mail merge operation.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.Execute(System.Data.DataRow)">
- <summary>
- Performs mail merge from a DataRow into the document.
- </summary>
- <remarks>
- <p>Use this method to fill mail merge fields in the document with values from a <b>DataRow</b>.</p>
- <p>This method ignores the <see cref="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveUnusedRegions" /> option.</p>
- </remarks>
- <param name="row">Row that contains data to be inserted into mail merge fields.
- Field names are not case sensitive.
- If a field name that is not found in the document is encountered, it is ignored.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.ExecuteWithRegions(Aspose.Words.MailMerging.IMailMergeDataSource)">
- <summary>
- Performs a mail merge from a custom data source with mail merge regions.
- </summary>
- <remarks>
- <p>Use this method to fill mail merge fields in the document with values from
- any custom data source such as an XML file or collections of business objects. You need to write your
- own class that implements the <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSource" /> interface.</p>
- <p>You can use this method only when <see cref="P:Aspose.Words.Fields.FieldOptions.IsBidiTextSupportedOnUpdate" /> is false,
- that is you do not need Right-To-Left language (such as Arabic or Hebrew) compatibility.</p>
- </remarks>
- <param name="dataSource">An object that implements the custom mail merge data source interface.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.ExecuteWithRegions(Aspose.Words.MailMerging.IMailMergeDataSourceCore)">
- <summary>
- Performs a mail merge from a custom data source with mail merge regions.
- </summary>
- <remarks>
- <p>Use this method to fill mail merge fields in the document with values from
- any custom data source such as an XML file or collections of business objects. You need to write your
- own class that implements the <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSourceCore" /> interface.</p>
- <p>You should use this method when <see cref="P:Aspose.Words.Fields.FieldOptions.IsBidiTextSupportedOnUpdate" /> is true,
- that is when you need Right-To-Left language (such as Arabic or Hebrew) compatibility.
- There are no other benefits from using of <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSourceCore" /> instead of
- <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSource" />.</p>
- </remarks>
- <param name="dataSource">An object that implements the custom mail merge data source interface.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.ExecuteWithRegions(Aspose.Words.MailMerging.IMailMergeDataSourceRoot)">
- <summary>
- Performs a mail merge from a custom data source with mail merge regions.
- </summary>
- <remarks>
- <p>Use this method to fill mail merge fields in the document with values from
- any custom data source such as an XML file or collections of business objects. You need to write your own classes
- that implement the <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSourceRoot" /> and <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSource" /> interfaces.</p>
- <p>You can use this method only when <see cref="P:Aspose.Words.Fields.FieldOptions.IsBidiTextSupportedOnUpdate" /> is false,
- that is you do not need Right-To-Left language (such as Arabic or Hebrew) compatibility.</p>
- </remarks>
- <param name="dataSourceRoot">An object that implements the custom mail merge data source root interface.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.ExecuteWithRegions(Aspose.Words.MailMerging.IMailMergeDataSourceRootCore)">
- <summary>
- Performs a mail merge from a custom data source with mail merge regions.
- </summary>
- <remarks>
- <p>Use this method to fill mail merge fields in the document with values from
- any custom data source such as an XML file or collections of business objects. You need to write your own classes
- that implement the <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSourceRootCore" /> and <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSourceCore" /> interfaces.</p>
- <p>You should use this method when <see cref="P:Aspose.Words.Fields.FieldOptions.IsBidiTextSupportedOnUpdate" /> is true,
- that is when you need Right-To-Left language (such as Arabic or Hebrew) compatibility.
- There are no other benefits from using of <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSourceRootCore" /> instead of
- <see cref="T:Aspose.Words.MailMerging.IMailMergeDataSourceRoot" />.</p>
- </remarks>
- <param name="dataSourceRoot">An object that implements the custom mail merge data source root interface.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.ExecuteWithRegions(System.Data.DataSet)">
- <overloads>Performs a mail merge operation into a document with mail merge regions. Supports parent-child (master-detail) data sources and nested mail merge regions.</overloads>
- <summary>
- Performs mail merge from a DataSet into a document with mail merge regions.
- </summary>
- <remarks>
- <p>Use this method to perform mail merge from one or more tables into repeatable mail
- merge regions in the document. The mail merge regions inside the document will dynamically
- grow to accommodate records in the corresponding tables.</p>
- <p>Every table in the DataSet must have a name.</p>
- <p>The document must have mail merge regions defined with names that refer to the tables
- in the DataSet.</p>
- <p>To specify a mail merge region in the document you need to insert two mail merge fields
- to mark beginning and end of the mail merge region.</p>
- <p>All document content that is included inside a mail merge region will be automatically
- repeated for every record in the DataTable.</p>
- <p>To mark beginning of a mail merge region insert a MERGEFIELD with name TableStart:MyTable,
- where MyTable corresponds to one of the table names in your DataSet.</p>
- <p>To mark the end of the mail merge region insert another MERGEFIELD with name TableEnd:MyTable.</p>
- <p>To insert a MERGEFIELD in Word use Insert/Field command and select MergeField then type the
- name of the field.</p>
- <p>The TableStart and TableEnd fields must be inside the same section in your document.</p>
- <p>If used inside a table, TableStart and TableEnd must be inside the same row in the table.</p>
- <p>Mail merge regions in a document should be well formed (there always needs to be a pair of matching
- TableStart and TableEnd merge fields with the same table name).</p>
- </remarks>
- <param name="dataSet">DataSet that contains data to be inserted into mail merge fields.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.ExecuteWithRegions(System.Data.DataTable)">
- <summary>
- Performs mail merge from a DataTable into the document with mail merge regions.
- </summary>
- <remarks>
- <p>The document must have a mail merge region defined with name that matches
- <b>DataTable.TableName</b>.</p>
- <p>If there are other mail merge regions defined in the document they are left intact.
- This allows to perform several mail merge operations.</p>
- </remarks>
- <param name="dataTable">Data source for the mail merge operation. The table must
- have its <b>TableName</b> property set.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.ExecuteWithRegionsADO(System.Object,System.String)">
- <summary>
- Performs mail merge from an ADO Recordset object into the document with mail merge regions.
- </summary>
- <remarks>
- <p>This method is useful when you intend to use Aspose.Words classes as
- COM objects from unmanaged code such as an application built using
- ASP or Visual Basic 6.0.</p>
- <p>For more information see description of MailMerge.ExecuteWithRegions(DataTable).</p>
- </remarks>
- <example>
- <code>
- [VBScript]
-
- Dim RS
- Set RS = CreateObject("ADODB.Recordset")
- RS.Open _
- "SELECT * FROM AsposeWordOrderDetails WHERE OrderId = 10444 ORDER BY ProductID", _
- "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=Northwind.mdb"
-
- Dim Helper
- Set Helper = CreateObject("Aspose.Words.ComHelper")
-
- Dim Doc
- Set Doc = Helper.Open("Invoice.doc")
-
- Doc.MailMerge.ExecuteWithRegionsADO RS, "OrderDetails"
- Doc.Save "Invoice Out VBScript.doc"
- </code>
- </example>
- <param name="recordset">ADO Recordset or Record object.</param>
- <param name="tableName">Name of the mail merge region in the document to populate.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.ExecuteWithRegions(System.Data.DataView)">
- <summary>
- Performs mail merge from a DataView into the document with mail merge regions.
- </summary>
- <remarks>
- <p>This method is useful if you retrieve data into a <b>DataTable</b> but then
- need to apply a filter or sort before the mail merge.</p>
- <p>The document must have a mail merge region defined with name that matches
- <b>DataView.Table.TableName</b>.</p>
- <p>If there are other mail merge regions defined in the document they are left intact.
- This allows to perform several mail merge operations.</p>
- </remarks>
- <param name="dataView">Data source for the mail merge operation. The source table
- of the <b>DataView</b> must have its <b>TableName</b> property set.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.ExecuteWithRegions(System.Data.IDataReader,System.String)">
- <summary>
- Performs mail merge from IDataReader into the document with mail merge regions.
- </summary>
- <remarks>
- <p>You can pass <b>SqlDataReader</b> or <b>OleDbDataReader</b> object into this
- method as a parameter because they both implemented <b>IDataReader</b> interface.</p>
- </remarks>
- <param name="dataReader">Source of the data records for mail merge such as OleDbDataReader or SqlDataReader.</param>
- <param name="tableName">Name of the mail merge region in the document to populate.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.GetFieldNames">
- <summary>
- Returns a collection of mail merge field names available in the document.
- </summary>
- <remarks>
- <p>Returns full merge field names including optional prefix. Does not eliminate duplicate field names.</p>
- <p>A new string[] array is created on every call.</p>
- <p>Includes "mustache" field names if <see cref="P:Aspose.Words.MailMerging.MailMerge.UseNonMergeFields" /> is <b>true</b>.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.GetFieldNamesForRegion(System.String)">
- <overloads>Get mail merge field names from the region.</overloads>
- <summary>
- Returns a collection of mail merge field names available in the region.
- </summary>
- <remarks>
- <p>Returns full merge field names including optional prefix. Does not eliminate duplicate field names.</p>
- <p>If document contains multiple regions with the same name the very first region is processed.</p>
- <p>A new string array is created on every call.</p>
- </remarks>
- <param name="regionName">Region name (case-insensitive).</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.GetFieldNamesForRegion(System.String,System.Int32)">
- <summary>
- Returns a collection of mail merge field names available in the region.
- </summary>
- <remarks>
- <p>Returns full merge field names including optional prefix. Does not eliminate duplicate field names.</p>
- <p>If document contains multiple regions with the same name the Nth region (zero-based) is processed.</p>
- <p>A new string array is created on every call.</p>
- </remarks>
- <param name="regionName">Region name (case-insensitive).</param>
- <param name="regionIndex">Region index (zero-based).</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.GetRegionsByName(System.String)">
- <summary>
- Returns a collection of mail merge regions with the specified name.
- </summary>
- <param name="regionName">Region name (case-insensitive).</param>
- <returns>The list of regions.</returns>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.GetRegionsByName(System.Collections.Generic.IList{Aspose.Words.MailMerging.MailMergeRegionInfo},System.String)">
- <summary>
- Returns a collection of mail merge regions with given name (from a list of regions).
- </summary>
- <param name="sourceListRegion">List of regions to search.</param>
- <param name="regionName">Region name (case-insensitive).</param>
- <returns>The list of regions.</returns>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.GetRegionsHierarchy">
- <summary>
- Returns a full hierarchy of regions (with fields) available in the document.
- </summary>
- <remarks>
- <p>Hierarchy is returned in the form of the <see cref="T:Aspose.Words.MailMerging.MailMergeRegionInfo" /> class.</p>
- </remarks>
- <returns>Regions' hierarchy.</returns>
- </member>
- <member name="M:Aspose.Words.MailMerging.MailMerge.DeleteFields">
- <summary>
- Removes mail merge related fields from the document.
- </summary>
- <remarks>
- <p>This method removes MERGEFIELD and NEXT fields from the document.</p>
- <p>This method could be useful if your mail merge operation does not always need
- to populate all fields in the document. Use this method to remove all remaining
- mail merge fields.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.RegionStartTag">
- <summary>
- Gets or sets a mail merge region start tag.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.RegionEndTag">
- <summary>
- Gets or sets a mail merge region end tag.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.CleanupOptions">
- <summary>
- Gets or sets a set of flags that specify what items should be removed during mail merge.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.CleanupParagraphsWithPunctuationMarks">
- <summary>
- Gets or sets a value indicating whether paragraphs with punctuation marks are considered as empty
- and should be removed if the <see cref="F:Aspose.Words.MailMerging.MailMergeCleanupOptions.RemoveEmptyParagraphs" /> option is specified.
- </summary>
- <remarks>
- The default value is <c>true</c>.
- </remarks>
- <remarks>
- Here is the complete list of cleanable punctuation marks:
- <list type="bullet"><item><description>!</description></item><item><description>,</description></item><item><description>.</description></item><item><description>:</description></item><item><description>;</description></item><item><description>?</description></item><item><description>¡</description></item><item><description>¿</description></item></list></remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.UseNonMergeFields">
- <summary>
- When true, specifies that in addition to MERGEFIELD fields, mail merge is performed into some other types of fields and
- also into "{{fieldName}}" tags.
- </summary>
- <remarks>
- <p>Normally, mail merge is only performed into MERGEFIELD fields, but several customers had their reporting
- built using other fields and had many documents created this way. To simplify migration (and because this
- approach was independently used by several customers) the ability to mail merge into other fields was introduced.</p>
- <p>When <b>UseNonMergeFields</b> is set to true, Aspose.Words will perform mail merge into the following fields:</p>
- <p>MERGEFIELD FieldName</p>
- <p>MACROBUTTON NOMACRO FieldName</p>
- <p>IF 0 = 0 "{FieldName}" ""</p>
- <p>Also, when <b>UserNonMergeFields</b> is set to true, Aspose.Words will perform mail merge into text tags
- "{{fieldName}}". These are not fields, but just text tags.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.PreserveUnusedTags">
- <summary>
- Gets or sets a value indicating whether the unused "mustache" tags should be preserved.
- </summary>
- <remarks>
- The default value is <b>false</b>.
- </remarks>
- <seealso cref="P:Aspose.Words.MailMerging.MailMerge.UseNonMergeFields" />
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.MergeDuplicateRegions">
- <summary>
- Gets or sets a value indicating whether all of the document mail merge regions with the name of a data source
- should be merged while executing of a mail merge with regions against the data source or just the first one.
- </summary>
- <remarks>
- The default value is <b>false</b>.
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.MergeWholeDocument">
- <summary>
- Gets or sets a value indicating whether fields in whole document is updated while executing of a mail merge with regions.
- </summary>
- <remarks>
- The default value is <b>false</b>.
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.UseWholeParagraphAsRegion">
- <summary>
- Gets or sets a value indicating whether whole paragraph with TableStart or TableEnd field
- or particular range between TableStart and TableEnd fields should be included into mail merge region.
- </summary>
- <remarks>
- The default value is <b>true</b>.
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.MappedDataFields">
- <summary>
- Returns a collection that represents mapped data fields for the mail merge operation.
- </summary>
- <remarks>
- <p>
- Mapped data fields allow to automatically map between names of fields in your data source
- and names of mail merge fields in the document.
- </p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.FieldMergingCallback">
- <summary>
- Occurs during mail merge when a mail merge field is encountered in the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.MailMergeCallback">
- <summary>
- Allows to handle particular events during mail merge.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.TrimWhitespaces">
- <summary>
- Gets or sets a value indicating whether trailing and leading whitespaces are trimmed from mail merge values.
- </summary>
- <remarks>
- The default value is <b>true</b>.
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.UnconditionalMergeFieldsAndRegions">
- <summary>
- Gets or sets a value indicating whether merge fields and merge regions are merged regardless of the parent IF field's condition.
- </summary>
- <remarks>
- The default value is <b>false</b>.
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.MailMerge.RetainFirstSectionStart">
- <summary>
- Gets or sets a value indicating whether the <see cref="P:Aspose.Words.PageSetup.SectionStart" /> of the first document section and its copies for subsequent data source rows
- are retained during mail merge or updated according to MS Word behaviour.
- </summary>
- <remarks>
- The default value is <b>true</b>.
- </remarks>
- </member>
- <member name="T:Aspose.Words.MailMerging.MappedDataFieldCollection">
- <summary>
- Allows to automatically map between names of fields in your data source
- and names of mail merge fields in the document.
- </summary>
- <remarks>
- <p>This is implemented as a collection of string keys into string values.
- The keys are the names of mail merge fields in the document and the values
- are the names of fields in your data source.</p>
- <seealso cref="T:Aspose.Words.MailMerging.MailMerge" />
- <seealso cref="P:Aspose.Words.MailMerging.MailMerge.MappedDataFields" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.MailMerging.MappedDataFieldCollection.GetEnumerator">
- <summary>
- Returns a dictionary enumerator object that can be used to iterate over all items in the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.MailMerging.MappedDataFieldCollection.Add(System.String,System.String)">
- <summary>
- Adds a new field mapping.
- </summary>
- <param name="documentFieldName">Case-sensitive name of the mail merge field in the document.</param>
- <param name="dataSourceFieldName">Case-sensitive name of the field in the data source.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MappedDataFieldCollection.ContainsKey(System.String)">
- <summary>
- Determines whether a mapping from the specified field in the document exists in the collection.
- </summary>
- <param name="documentFieldName">Case-sensitive name of the mail merge field in the document.</param>
- <returns>True if item is found in the collection; otherwise, false.</returns>
- </member>
- <member name="M:Aspose.Words.MailMerging.MappedDataFieldCollection.ContainsValue(System.String)">
- <summary>
- Determines whether a mapping from the specified field in the data source exists in the collection.
- </summary>
- <param name="dataSourceFieldName">Case-sensitive name of the field in the data source.</param>
- <returns>True if item is found in the collection; otherwise, false.</returns>
- </member>
- <member name="M:Aspose.Words.MailMerging.MappedDataFieldCollection.Remove(System.String)">
- <summary>
- Removes a field mapping.
- </summary>
- <param name="documentFieldName">Case-sensitive name of the mail merge field in the document.</param>
- </member>
- <member name="M:Aspose.Words.MailMerging.MappedDataFieldCollection.Clear">
- <summary>
- Removes all elements from the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.MappedDataFieldCollection.Count">
- <summary>
- Gets the number of elements contained in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.MappedDataFieldCollection.Item(System.String)">
- <summary>
- Gets or sets the name of the field in the data source associated with the specified mail merge field.
- </summary>
- </member>
- <member name="T:Aspose.Words.MailMerging.FieldMergingArgs">
- <summary>
- Provides data for the <b>MergeField</b> event.
- </summary>
- <remarks>
- <p>The <b>MergeField</b> event occurs during mail merge when a simple mail merge
- field is encountered in the document. You can respond to this event to return
- text for the mail merge engine to insert into the document.</p>
- <seealso cref="T:Aspose.Words.MailMerging.IFieldMergingCallback" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.FieldMergingArgs.Text">
- <summary>
- Gets or sets the text that will be inserted into the document for the current merge field.
- </summary>
- <remarks>
- <p>When your event handler is called, this property is set to null.</p>
- <p>If you leave Text as null, the mail merge engine will insert <see cref="P:Aspose.Words.MailMerging.FieldMergingArgsBase.FieldValue" /> in place of the merge field.</p>
- <p>If you set Text to any string (including empty), the string will be inserted into the document in place of the merge field.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.MailMerging.FieldMergingArgsBase">
- <summary>
- Base class for <see cref="T:Aspose.Words.MailMerging.FieldMergingArgs" /> and <see cref="T:Aspose.Words.MailMerging.ImageFieldMergingArgs" />.
- </summary>
- <remarks>
- <seealso cref="T:Aspose.Words.MailMerging.FieldMergingArgs" />
- <seealso cref="T:Aspose.Words.MailMerging.ImageFieldMergingArgs" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.FieldMergingArgsBase.Document">
- <summary>
- Returns the <see cref="P:Aspose.Words.MailMerging.FieldMergingArgsBase.Document" /> object for which the mail merge is performed.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.FieldMergingArgsBase.TableName">
- <summary>
- Gets the name of the data table for the current merge operation or empty string if the name is not available.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.FieldMergingArgsBase.RecordIndex">
- <summary>
- Gets the zero based index of the record that is being merged.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.FieldMergingArgsBase.FieldName">
- <summary>
- Gets the name of the merge field in the data source.
- </summary>
- <remarks>
- <p>If you have a mapping from a document field name to a different data source field name,
- then this is the mapped field name.</p>
- <p>If you specified a field name prefix, for example "Image:MyFieldName" in the document,
- then <b>FieldName</b> returns field name without the prefix, that is "MyFieldName".</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.FieldMergingArgsBase.DocumentFieldName">
- <summary>
- Gets the name of the merge field as specified in the document.
- </summary>
- <remarks>
- <p>If you have a mapping from a document field name to a different data source field name,
- then this is the original field name as specified in the document.</p>
- <p>If you specified a field name prefix, for example "Image:MyFieldName" in the document,
- then <b>DocumentFieldName</b> returns field name without the prefix, that is "MyFieldName".</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.FieldMergingArgsBase.FieldValue">
- <summary>
- Gets or sets the value of the field from the data source.
- </summary>
- <remarks>
- This property contains a value that has just been selected from your data source
- for this field by the mail merge engine. You can also replace the value by setting the property.
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.FieldMergingArgsBase.Field">
- <summary>
- Gets the object that represents the current merge field.
- </summary>
- </member>
- <member name="T:Aspose.Words.MailMerging.IFieldMergingCallback">
- <summary>
- Implement this interface if you want to control how data is inserted into merge fields during a mail merge operation.
- </summary>
- </member>
- <member name="M:Aspose.Words.MailMerging.IFieldMergingCallback.FieldMerging(Aspose.Words.MailMerging.FieldMergingArgs)">
- <summary>
- Called when the Aspose.Words mail merge engine is about to insert data into a merge field in the document.
- </summary>
- </member>
- <member name="M:Aspose.Words.MailMerging.IFieldMergingCallback.ImageFieldMerging(Aspose.Words.MailMerging.ImageFieldMergingArgs)">
- <summary>
- Called when the Aspose.Words mail merge engine is about to insert an image into a merge field.
- </summary>
- </member>
- <member name="T:Aspose.Words.MailMerging.ImageFieldMergingArgs">
- <summary>
- Provides data for the <see cref="M:Aspose.Words.MailMerging.IFieldMergingCallback.ImageFieldMerging(Aspose.Words.MailMerging.ImageFieldMergingArgs)" /> event.
- </summary>
- <remarks>
- <p>This event occurs during mail merge when an image mail merge
- field is encountered in the document. You can respond to this event to return a
- file name, stream, or an <see cref="T:System.Drawing.Image" /> object to the mail merge
- engine so it is inserted into the document.</p>
- <p>There are three properties available <see cref="P:Aspose.Words.MailMerging.ImageFieldMergingArgs.ImageFileName" />,
- <see cref="P:Aspose.Words.MailMerging.ImageFieldMergingArgs.ImageStream" /> and <see cref="P:Aspose.Words.MailMerging.ImageFieldMergingArgs.Image" /> to specify where the image must be taken from.
- Set only one of these properties.</p>
- <p>To insert an image mail merge field into a document in Word, select Insert/Field command,
- then select MergeField and type Image:MyFieldName.</p>
- <seealso cref="T:Aspose.Words.MailMerging.IFieldMergingCallback" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.ImageFieldMergingArgs.ImageFileName">
- <summary>
- Sets the file name of the image that the mail merge engine must insert into the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.ImageFieldMergingArgs.ImageStream">
- <summary>
- Specifies the stream for the mail merge engine to read an image from.
- </summary>
- <remarks>
- <p>Aspose.Words closes this stream after it merges the image into the document.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.ImageFieldMergingArgs.Image">
- <summary>
- Specifies the image that the mail merge engine must insert into the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.MailMerging.ImageFieldMergingArgs.Shape">
- <summary>
- Specifies the shape that the mail merge engine must insert into the document.
- </summary>
- <remarks>
- <p>When this property is specified, the mail merge engine ignores all other properties like <see cref="P:Aspose.Words.MailMerging.ImageFieldMergingArgs.ImageFileName" /> or <see cref="P:Aspose.Words.MailMerging.ImageFieldMergingArgs.ImageStream" />
- and simply inserts the shape into the document.</p>
- <p>Use this property to fully control the process of merging an image merge field.
- For example, you can specify <see cref="P:Aspose.Words.Drawing.ShapeBase.WrapType" /> or any other shape property to fine tune the resulting node. However, please note that
- you are responsible for providing the content of the shape.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.ImageFieldMergingArgs.ImageWidth">
- <summary>
- Specifies the image width for the image to insert into the document.
- </summary>
- <remarks>
- <para>
- The value of this property initially comes from the corresponding MERGEFIELD's code, contained in the
- template document. To override the initial value, you should assign an instance of
- <see cref="T:Aspose.Words.Fields.MergeFieldImageDimension" /> class to this property or set the properties for the instance
- of <see cref="T:Aspose.Words.Fields.MergeFieldImageDimension" /> class, returned by this property.
- </para>
- <para>
- To indicate that the original value of the image width should be applied, you should assign the <b>null</b>
- value to this property or set the <see cref="P:Aspose.Words.Fields.MergeFieldImageDimension.Value" /> property for the instance
- of <see cref="T:Aspose.Words.Fields.MergeFieldImageDimension" /> class, returned by this property, to a negative value.
- </para>
- <seealso cref="T:Aspose.Words.Fields.MergeFieldImageDimension" />
- <seealso cref="T:Aspose.Words.Fields.MergeFieldImageDimensionUnit" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.MailMerging.ImageFieldMergingArgs.ImageHeight">
- <summary>
- Specifies the image height for the image to insert into the document.
- </summary>
- <remarks>
- <para>
- The value of this property initially comes from the corresponding MERGEFIELD's code, contained in the
- template document. To override the initial value, you should assign an instance of
- <see cref="T:Aspose.Words.Fields.MergeFieldImageDimension" /> class to this property or set the properties for the instance
- of <see cref="T:Aspose.Words.Fields.MergeFieldImageDimension" /> class, returned by this property.
- </para>
- <para>
- To indicate that the original value of the image height should be applied, you should assign the <b>null</b>
- value to this property or set the <see cref="P:Aspose.Words.Fields.MergeFieldImageDimension.Value" /> property for the instance
- of <see cref="T:Aspose.Words.Fields.MergeFieldImageDimension" /> class, returned by this property, to a negative value.
- </para>
- <seealso cref="T:Aspose.Words.Fields.MergeFieldImageDimension" />
- <seealso cref="T:Aspose.Words.Fields.MergeFieldImageDimensionUnit" />
- </remarks>
- </member>
- <member name="T:Aspose.Words.MailMerging.NamespaceDoc">
- <summary>
- <p>The <b>Aspose.Words.MailMerging</b> namespace contains classes of the
- "original" mail merge reporting engine.</p>
- <p>This reporting engine requires the document to be marked up with Microsoft Word
- mail merge fields, but supports more functionality than Microsoft Word's mail merge.</p>
- <p>The engine allows to quickly and easily populate a report template with data from various
- sources such as <b>DataTable</b>, <b>DataSet</b>, <b>DataView</b>, <b>IDataReader</b> or an array of values.</p>
- <p>The <see cref="T:Aspose.Words.MailMerging.MailMerge" /> object which provides access to the reporting functionality
- is available via the <see cref="P:Aspose.Words.Document.MailMerge">Document.MailMerge</see> property.</p>
- <p>For the newer and more advanced reporting engine based on the LINQ method syntax see
- <see cref="N:Aspose.Words.Reporting" />.</p>
- <seealso cref="N:Aspose.Words.Reporting" />
- </summary>
- </member>
- <member name="T:Aspose.Words.Rendering.NodeRendererBase">
- <summary>
- Base class for <see cref="T:Aspose.Words.Rendering.ShapeRenderer" /> and <see cref="T:Aspose.Words.Rendering.OfficeMathRenderer" />.
- </summary>
- </member>
- <member name="M:Aspose.Words.Rendering.NodeRendererBase.GetSizeInPixels(System.Single,System.Single)">
- <summary>
- Calculates the size of the shape in pixels for a specified zoom factor and resolution.
- </summary>
- <remarks>
- <para>This method converts <see cref="P:Aspose.Words.Rendering.NodeRendererBase.SizeInPoints" /> into size in pixels and it is useful
- when you want to create a bitmap for rendering the shape neatly onto the bitmap.</para>
- </remarks>
- <param name="scale">The zoom factor (1.0 is 100%).</param>
- <param name="dpi">The resolution (horizontal and vertical) to convert from points to pixels (dots per inch).</param>
- <returns>The size of the shape in pixels.</returns>
- </member>
- <member name="M:Aspose.Words.Rendering.NodeRendererBase.GetSizeInPixels(System.Single,System.Single,System.Single)">
- <summary>
- Calculates the size of the shape in pixels for a specified zoom factor and resolution.
- </summary>
- <remarks>
- <para>This method converts <see cref="P:Aspose.Words.Rendering.NodeRendererBase.SizeInPoints" /> into size in pixels and it is useful
- when you want to create a bitmap for rendering the shape neatly onto the bitmap.</para>
- </remarks>
- <param name="scale">The zoom factor (1.0 is 100%).</param>
- <param name="horizontalDpi">The horizontal resolution to convert from points to pixels (dots per inch).</param>
- <param name="verticalDpi">The vertical resolution to convert from points to pixels (dots per inch).</param>
- <returns>The size of the shape in pixels.</returns>
- </member>
- <member name="M:Aspose.Words.Rendering.NodeRendererBase.GetBoundsInPixels(System.Single,System.Single)">
- <summary>
- Calculates the bounds of the shape in pixels for a specified zoom factor and resolution.
- </summary>
- <remarks>
- <para>This method converts <see cref="P:Aspose.Words.Rendering.NodeRendererBase.BoundsInPoints" /> into rectangle in pixels.</para>
- </remarks>
- <param name="scale">The zoom factor (1.0 is 100%).</param>
- <param name="dpi">The resolution (horizontal and vertical) to convert from points to pixels (dots per inch).</param>
- <returns>The actual (as rendered on the page) bounding box of the shape in pixels.</returns>
- </member>
- <member name="M:Aspose.Words.Rendering.NodeRendererBase.GetBoundsInPixels(System.Single,System.Single,System.Single)">
- <summary>
- Calculates the bounds of the shape in pixels for a specified zoom factor and resolution.
- </summary>
- <remarks>
- <para>This method converts <see cref="P:Aspose.Words.Rendering.NodeRendererBase.BoundsInPoints" /> into rectangle in pixels.</para>
- </remarks>
- <param name="scale">The zoom factor (1.0 is 100%).</param>
- <param name="horizontalDpi">The horizontal resolution to convert from points to pixels (dots per inch).</param>
- <param name="verticalDpi">The vertical resolution to convert from points to pixels (dots per inch).</param>
- <returns>The actual (as rendered on the page) bounding box of the shape in pixels.</returns>
- </member>
- <member name="M:Aspose.Words.Rendering.NodeRendererBase.GetOpaqueBoundsInPixels(System.Single,System.Single)">
- <summary>
- Calculates the opaque bounds of the shape in pixels for a specified zoom factor and resolution.
- </summary>
- <remarks>
- <para>This method converts <see cref="P:Aspose.Words.Rendering.NodeRendererBase.OpaqueBoundsInPoints" /> into rectangle in pixels and it is useful
- when you want to create a bitmap for rendering the shape with only opaque part of the shape.</para>
- </remarks>
- <param name="scale">The zoom factor (1.0 is 100%).</param>
- <param name="dpi">The resolution to convert from points to pixels (dots per inch).</param>
- <returns>The opaque rectangle of the shape in pixels.</returns>
- </member>
- <member name="M:Aspose.Words.Rendering.NodeRendererBase.GetOpaqueBoundsInPixels(System.Single,System.Single,System.Single)">
- <summary>
- Calculates the opaque bounds of the shape in pixels for a specified zoom factor and resolution.
- </summary>
- <remarks>
- <para>This method converts <see cref="P:Aspose.Words.Rendering.NodeRendererBase.OpaqueBoundsInPoints" /> into rectangle in pixels and it is useful
- when you want to create a bitmap for rendering the shape with only opaque part of the shape.</para>
- </remarks>
- <param name="scale">The zoom factor (1.0 is 100%).</param>
- <param name="horizontalDpi">The horizontal resolution to convert from points to pixels (dots per inch).</param>
- <param name="verticalDpi">The vertical resolution to convert from points to pixels (dots per inch).</param>
- <returns>The opaque rectangle of the shape in pixels.</returns>
- </member>
- <member name="M:Aspose.Words.Rendering.NodeRendererBase.RenderToScale(System.Drawing.Graphics,System.Single,System.Single,System.Single)">
- <summary>
- Renders the shape into a <see cref="T:System.Drawing.Graphics" />
- object to a specified scale.
- </summary>
- <param name="graphics">The object where to render to.</param>
- <param name="x">The X coordinate (in world units) of the top left corner of the rendered shape.</param>
- <param name="y">The Y coordinate (in world units) of the top left corner of the rendered shape.</param>
- <param name="scale">The scale for rendering the shape (1.0 is 100%).</param>
- <returns>The width and height (in world units) of the rendered shape.</returns>
- </member>
- <member name="M:Aspose.Words.Rendering.NodeRendererBase.RenderToSize(System.Drawing.Graphics,System.Single,System.Single,System.Single,System.Single)">
- <summary>
- Renders the shape into a <see cref="T:System.Drawing.Graphics" />
- object to a specified size.
- </summary>
- <param name="graphics">The object where to render to.</param>
- <param name="x">The X coordinate (in world units) of the top left corner of the rendered shape.</param>
- <param name="y">The Y coordinate (in world units) of the top left corner of the rendered shape.</param>
- <param name="width">The maximum width (in world units) that can be occupied by the rendered shape.</param>
- <param name="height">The maximum height (in world units) that can be occupied by the rendered shape.</param>
- <returns>The scale that was automatically calculated for the rendered shape to fit the specified size.</returns>
- </member>
- <member name="M:Aspose.Words.Rendering.NodeRendererBase.Save(System.String,Aspose.Words.Saving.ImageSaveOptions)">
- <overloads>Renders the shape and saves into an image.</overloads>
- <summary>
- Renders the shape into an image and saves into a file.
- </summary>
- <param name="fileName">The name for the image file. If a file with the specified name already exists, the existing file is overwritten.</param>
- <param name="saveOptions">Specifies the options that control how the shape is rendered and saved. Can be null.</param>
- </member>
- <member name="M:Aspose.Words.Rendering.NodeRendererBase.Save(System.IO.Stream,Aspose.Words.Saving.ImageSaveOptions)">
- <summary>
- Renders the shape into an image and saves into a stream.
- </summary>
- <param name="stream">The stream where to save the image of the shape.</param>
- <param name="saveOptions">Specifies the options that control how the shape is rendered and saved. Can be null.
- If this is null, the image will be saved in the PNG format.</param>
- </member>
- <member name="P:Aspose.Words.Rendering.NodeRendererBase.SizeInPoints">
- <summary>
- Gets the actual size of the shape in points.
- </summary>
- <remarks>
- <para>This property returns the size of the actual (as rendered on the page) bounding box of the shape.
- The size takes into account shape rotation (if any).</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Rendering.NodeRendererBase.BoundsInPoints">
- <summary>
- Gets the actual bounds of the shape in points.
- </summary>
- <remarks>
- <para>This property returns the actual (as rendered on the page) bounding box of the shape.
- The bounds takes into account shape rotation (if any).</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Rendering.NodeRendererBase.OpaqueBoundsInPoints">
- <summary>
- Gets the opaque bounds of the shape in points.
- </summary>
- <remarks>
- <para>This property returns the opaque (i.e. transparent parts of the shape are ignored) bounding box of the shape.
- The bounds takes the shape rotation into account.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Rendering.OfficeMathRenderer">
- <summary>
- Provides methods to render an individual <see cref="T:Aspose.Words.Math.OfficeMath" />
- to a raster or vector image or to a Graphics object.
- </summary>
- </member>
- <member name="M:Aspose.Words.Rendering.OfficeMathRenderer.#ctor(Aspose.Words.Math.OfficeMath)">
- <summary>
- Initializes a new instance of this class.
- </summary>
- <param name="math">The OfficeMath object that you want to render.</param>
- </member>
- <member name="T:Aspose.Words.Rendering.PrinterSettingsContainer">
- <summary>
- Represent a storage for some parameters of <see cref="T:System.Drawing.Printing.PrinterSettings" /> object.
- </summary>
- <remarks>
- Access to data of <see cref="T:System.Drawing.Printing.PrinterSettings" /> takes long time.
- <see cref="T:Aspose.Words.Rendering.PrinterSettingsContainer" /> caches parameters from <see cref="T:System.Drawing.Printing.PrinterSettings" />,
- so printing works faster.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Rendering.PrinterSettingsContainer.#ctor(System.Drawing.Printing.PrinterSettings)">
- <summary>
- Creates a container for <see cref="T:System.Drawing.Printing.PrinterSettings" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Rendering.PrinterSettingsContainer.PaperSizes">
- <summary>
- See <see cref="P:System.Drawing.Printing.PrinterSettings.PaperSizes" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Rendering.PrinterSettingsContainer.DefaultPageSettingsPaperSource">
- <summary>
- See <see cref="T:System.Drawing.Printing.PaperSource" /> of <see cref="P:System.Drawing.Printing.PrinterSettings.DefaultPageSettings" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Rendering.PrinterSettingsContainer.PaperSources">
- <summary>
- See <see cref="P:System.Drawing.Printing.PrinterSettings.PaperSources" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Rendering.ThumbnailGeneratingOptions">
- <summary>
- Can be used to specify additional options when generating thumbnail for a document.
- </summary>
- <remarks>
- User can call method <see cref="M:Aspose.Words.Document.UpdateThumbnail(Aspose.Words.Rendering.ThumbnailGeneratingOptions)" /> to generate
- <see cref="P:Aspose.Words.Properties.BuiltInDocumentProperties.Thumbnail" /> for a document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Rendering.ThumbnailGeneratingOptions.GenerateFromFirstPage">
- <summary>
- Specifies whether to generate thumbnail from first page of the document or first image.
- </summary>
- <remarks>
- Default is <c>true</c>, which means thumbnail will be generated from first page of the document.
- If value is <c>false</c> and there is no image in the document, thumbnail will be generated
- from first page of the document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Rendering.ThumbnailGeneratingOptions.ThumbnailSize">
- <summary>
- Size of generated thumbnail in pixels.
- Default is 600x900.
- </summary>
- </member>
- <member name="T:Aspose.Words.Rendering.ShapeRenderer">
- <summary>
- Provides methods to render an individual <see cref="T:Aspose.Words.Drawing.Shape" /> or <see cref="T:Aspose.Words.Drawing.GroupShape" />
- to a raster or vector image or to a Graphics object.
- </summary>
- </member>
- <member name="M:Aspose.Words.Rendering.ShapeRenderer.#ctor(Aspose.Words.Drawing.ShapeBase)">
- <summary>
- Initializes a new instance of this class.
- </summary>
- <param name="shape">The DrawinML shape object that you want to render.</param>
- </member>
- <member name="T:Aspose.Words.Rendering.NamespaceDoc">
- <summary>
- <para>The <b>Aspose.Words.Rendering</b> namespace provides classes that allow to
- customize printing or rendering of documents.</para>
- <para>To actually render, print or convert a document use the corresponding methods on the
- <see cref="T:Aspose.Words.Document" /> object.</para>
- </summary>
- </member>
- <member name="T:Aspose.Words.Rendering.PageInfo">
- <summary>
- Represents information about a particular document page.
- </summary>
- <remarks>
- <para>The page width and height returned by this object represent the "final" size of the page e.g. they are
- already rotated to the correct orientation.</para>
- <seealso cref="M:Aspose.Words.Document.GetPageInfo(System.Int32)" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Rendering.PageInfo.GetSizeInPixels(System.Single,System.Single)">
- <summary>
- Calculates the page size in pixels for a specified zoom factor and resolution.
- </summary>
- <param name="scale">The zoom factor (1.0 is 100%).</param>
- <param name="dpi">The resolution (horizontal and vertical) to convert from points to pixels (dots per inch).</param>
- <returns>The size of the page in pixels.</returns>
- </member>
- <member name="M:Aspose.Words.Rendering.PageInfo.GetSizeInPixels(System.Single,System.Single,System.Single)">
- <summary>
- Calculates the page size in pixels for a specified zoom factor and resolution.
- </summary>
- <param name="scale">The zoom factor (1.0 is 100%).</param>
- <param name="horizontalDpi">The horizontal resolution to convert from points to pixels (dots per inch).</param>
- <param name="verticalDpi">The vertical resolution to convert from points to pixels (dots per inch).</param>
- <returns>The size of the page in pixels.</returns>
- </member>
- <member name="M:Aspose.Words.Rendering.PageInfo.GetDotNetPaperSize(System.Drawing.Printing.PrinterSettings.PaperSizeCollection)">
- <summary>
- Gets the <see cref="T:System.Drawing.Printing.PaperSize" /> object suitable for printing
- the page represented by this <see cref="T:Aspose.Words.Rendering.PageInfo" />.
- </summary>
- <param name="paperSizes">Available paper sizes.</param>
- <returns>An object that you can use in the .NET printing framework to specify the paper size.</returns>
- </member>
- <member name="M:Aspose.Words.Rendering.PageInfo.GetSpecifiedPrinterPaperSource(System.Drawing.Printing.PrinterSettings.PaperSourceCollection,System.Drawing.Printing.PaperSource)">
- <summary>
- Gets the <see cref="T:System.Drawing.Printing.PaperSource" /> object suitable for printing
- the page represented by this <see cref="T:Aspose.Words.Rendering.PageInfo" />.
- </summary>
- <param name="paperSources">Available paper sources.</param>
- <param name="defaultPageSettingsPaperSource">Paper source defined in default printer settings.</param>
- <returns>An object that you can use in the .NET printing framework to specify the paper source.</returns>
- <remarks>
- <para>This method requires .NET Framework 2.0 or later.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Rendering.PageInfo.PaperSize">
- <summary>
- Gets the paper size as enumeration.
- </summary>
- </member>
- <member name="P:Aspose.Words.Rendering.PageInfo.WidthInPoints">
- <summary>
- Gets the width of the page in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.Rendering.PageInfo.HeightInPoints">
- <summary>
- Gets the height of the page in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.Rendering.PageInfo.SizeInPoints">
- <summary>
- Gets the page size in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.Rendering.PageInfo.PaperTray">
- <summary>
- Gets the paper tray (bin) for this page as specified in the document.
- The value is implementation (printer) specific.
- </summary>
- </member>
- <member name="P:Aspose.Words.Rendering.PageInfo.Landscape">
- <summary>
- Returns true if the page orientation specified in the document for this page is landscape.
- </summary>
- </member>
- <member name="T:Aspose.Words.Rendering.AsposeWordsPrintDocument">
- <summary>
- Provides a default implementation for printing of a <see cref="T:Aspose.Words.Document" /> within
- the .NET printing framework.
- </summary>
- <remarks>
- <para>
- <see cref="T:Aspose.Words.Rendering.AsposeWordsPrintDocument" /> overrides <see cref="M:System.Drawing.Printing.PrintDocument.OnBeginPrint(System.Drawing.Printing.PrintEventArgs)" />
- to print the range of pages that is specified in <see cref="P:System.Drawing.Printing.PrintDocument.PrinterSettings" />.</para>
- <para>A single Word document can consist of multiple sections that specify pages with different sizes,
- orientation and paper trays. <see cref="T:Aspose.Words.Rendering.AsposeWordsPrintDocument" /> overrides
- <see cref="M:System.Drawing.Printing.PrintDocument.OnQueryPageSettings(System.Drawing.Printing.QueryPageSettingsEventArgs)" /> to properly select paper size, orientation
- and paper source when printing a Word document.</para>
- <para>Microsoft Word stores printer specific values for paper trays in a Word document and therefore,
- only printing on the same printer model as the one that was selected when the user specified the paper trays
- will result in printing from the correct trays. If you print a document on a different printer, then most likely
- the default paper tray will be used, not the trays specified in the document.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Rendering.AsposeWordsPrintDocument.#ctor(Aspose.Words.Document)">
- <summary>
- Initializes a new instance of this class.
- </summary>
- <param name="document">The document to print.</param>
- </member>
- <member name="M:Aspose.Words.Rendering.AsposeWordsPrintDocument.CachePrinterSettings">
- <summary>
- Reads and caches some fields of <see cref="T:System.Drawing.Printing.PrinterSettings" />
- to reduce printing time.
- </summary>
- <remarks>
- This method is called before the printing starts if it wasn't executed previously.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Math.OfficeMathDisplayType">
- <summary>
- Specifies the display format type of the equation.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.OfficeMathDisplayType.Display">
- <summary>
- The Office Math is displayed on its own line.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.OfficeMathDisplayType.Inline">
- <summary>
- The Office Math is displayed inline with the text.
- </summary>
- </member>
- <member name="T:Aspose.Words.Math.OfficeMathJustification">
- <summary>
- Specifies the justification of the equation.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.OfficeMathJustification.CenterGroup">
- <summary>
- Justifies instances of mathematical text to the left with respect to each other, and centers the group of mathematical
- text (the Math Paragraph) with respect to the page.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.OfficeMathJustification.Center">
- <summary>
- Centers each instance of mathematical text individually with respect to margins.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.OfficeMathJustification.Left">
- <summary>
- Left justification of Math Paragraph.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.OfficeMathJustification.Right">
- <summary>
- Right Justification of Math Paragraph.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.OfficeMathJustification.Inline">
- <summary>
- Inline position of Math.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.OfficeMathJustification.Default">
- <summary>
- Default value <see cref="F:Aspose.Words.Math.OfficeMathJustification.CenterGroup" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Math.MathObjectType">
- <summary>
- Specifies type of an Office Math object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.OMath">
- <summary>
- Instance of mathematical text.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.OMathPara">
- <summary>
- Math paragraph, or display math zone, that contains one or more <see cref="F:Aspose.Words.Math.MathObjectType.OMath" /> elements that are in display mode.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Accent">
- <summary>
- Accent function, consisting of a base and a combining diacritical mark.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Bar">
- <summary>
- Bar function, consisting of a base argument and an overbar or underbar.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.BorderBox">
- <summary>
- Border Box object, consisting of a border drawn around an instance of mathematical text (such as a formula or equation)
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Box">
- <summary>
- Box object, which is used to group components of an equation or other instance of mathematical text.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Delimiter">
- <summary>
- Delimiter object, consisting of opening and closing delimiters (such as parentheses,
- braces, brackets, and vertical bars), and an element contained inside.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Degree">
- <summary>
- Degree in the mathematical radical.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Argument">
- <summary>
- Argument object. Encloses Office Math entities when they are used as arguments to other Office Math entities.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Array">
- <summary>
- Array object, consisting of one or more equations, expressions, or other mathematical text runs
- that can be vertically justified as a unit with respect to surrounding text on the line.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Fraction">
- <summary>
- Fraction object, consisting of a numerator and denominator separated by a fraction bar.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Denominator">
- <summary>
- Denominator of a fraction object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Numerator">
- <summary>
- Numerator of the Fraction object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Function">
- <summary>
- Function-Apply object, which consists of a function name and an argument element acted upon.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.FunctionName">
- <summary>
- Name of the function. For example, function names are sin and cos.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.GroupCharacter">
- <summary>
- Group-Character object, consisting of a character drawn above or below text, often
- with the purpose of visually grouping items
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Limit">
- <summary>
- Lower limit of the <see cref="F:Aspose.Words.Math.MathObjectType.LowerLimit" /> object and
- the upper limit of the <see cref="F:Aspose.Words.Math.MathObjectType.UpperLimit" /> function.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.LowerLimit">
- <summary>
- Lower-Limit object, consisting of text on the baseline and reduced-size text immediately below it.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.UpperLimit">
- <summary>
- Upper-Limit object, consisting of text on the baseline and reduced-size text immediately above it.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Matrix">
- <summary>
- Matrix object, consisting of one or more elements laid out in one or more rows and one or more columns.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.MatrixRow">
- <summary>
- Single row of the matrix.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.NAry">
- <summary>
- N-ary object, consisting of an n-ary object, a base (or operand), and optional upper and lower limits.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Phantom">
- <summary>
- Phantom object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Radical">
- <summary>
- Radical object, consisting of a radical, a base element, and an optional degree .
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.SubscriptPart">
- <summary>
- Subscript of the object that can have subscript part.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.SuperscriptPart">
- <summary>
- Superscript of the superscript object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.PreSubSuperscript">
- <summary>
- Pre-Sub-Superscript object, which consists of a base element and a subscript and superscript placed to the left of the base.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Subscript">
- <summary>
- Subscript object, which consists of a base element and a reduced-size script placed below and to the right.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.SubSuperscript">
- <summary>
- Sub-superscript object, which consists of a base element, a reduced-size script placed below and to the right, and a reduced-size script placed above and to the right.
- </summary>
- </member>
- <member name="F:Aspose.Words.Math.MathObjectType.Supercript">
- <summary>
- Superscript object, which consists of a base element and a reduced-size script placed above and to the right.
- </summary>
- </member>
- <member name="T:Aspose.Words.Math.NamespaceDoc">
- <summary>
- <p>The <b>Aspose.Words.Math</b> namespace contains classes that represent Office Math elements.</p>
- </summary>
- </member>
- <member name="T:Aspose.Words.Math.OfficeMath">
- <summary>
- Represents an Office Math object such as function, equation, matrix or alike. Can contain child elements
- including runs of mathematical text, bookmarks, comments, other <see cref="T:Aspose.Words.Math.OfficeMath" /> instances and some other nodes.
- </summary>
- <remarks>
- <para>In this version of Aspose.Words, <see cref="T:Aspose.Words.Math.OfficeMath" /> nodes do not provide public methods
- and properties to create or modify a OfficeMath object. In this version you are not able to instantiate
- <see cref="N:Aspose.Words.Math" /> nodes or modify existing except deleting them.</para>
- <p>
- <see cref="T:Aspose.Words.Math.OfficeMath" /> can only be a child of <see cref="T:Aspose.Words.Paragraph" />.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Math.OfficeMath.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitOfficeMathStart(Aspose.Words.Math.OfficeMath)" />, then calls <see cref="M:Aspose.Words.Node.Accept(Aspose.Words.DocumentVisitor)" /> for all
- child nodes of the Office Math and calls <see cref="M:Aspose.Words.DocumentVisitor.VisitOfficeMathEnd(Aspose.Words.Math.OfficeMath)" /> at the end.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Math.OfficeMath.GetMathRenderer">
- <summary>
- Creates and returns an object that can be used to render this equation into an image.
- </summary>
- <remarks>
- <para>This method just invokes the <see cref="T:Aspose.Words.Rendering.OfficeMathRenderer" /> constructor and passes
- this object as a parameter.</para>
- </remarks>
- <returns>The renderer object for this equation.</returns>
- </member>
- <member name="P:Aspose.Words.Math.OfficeMath.NodeType">
- <summary>
- Returns <b>NodeType.OfficeMath</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Math.OfficeMath.ParentParagraph">
- <summary>
- Retrieves the parent <see cref="T:Aspose.Words.Paragraph" /> of this node.
- </summary>
- </member>
- <member name="P:Aspose.Words.Math.OfficeMath.MathObjectType">
- <summary>
- Gets type <see cref="P:Aspose.Words.Math.OfficeMath.MathObjectType" /> of this Office Math object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Math.OfficeMath.EquationXmlEncoding">
- <summary>
- Gets/sets an encoding that was used to encode equation XML, if this office math object is read from
- equation XML. We use the encoding on saving a document to write in same encoding that it was read.
- </summary>
- </member>
- <member name="P:Aspose.Words.Math.OfficeMath.Justification">
- <summary>
- Gets/sets Office Math justification.
- </summary>
- <remarks>
- <para>Justification cannot be set to the Office Math with display format type <see cref="F:Aspose.Words.Math.OfficeMathDisplayType.Inline" />.</para>
- <para>Inline justification cannot be set to the Office Math with display format type <see cref="F:Aspose.Words.Math.OfficeMathDisplayType.Display" />.</para>
- <para>Corresponding <see cref="P:Aspose.Words.Math.OfficeMath.DisplayType" /> has to be set before setting Office Math justification.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Math.OfficeMath.DisplayType">
- <summary>
- Gets/sets Office Math display format type which represents whether an equation is displayed inline with the text
- or displayed on its own line.
- </summary>
- <remarks>
- <para>Display format type has effect for top level Office Math only.</para>
- <para>Returned display format type is always <see cref="F:Aspose.Words.Math.OfficeMathDisplayType.Inline" /> for nested Office Math.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Reporting.CsvDataLoadOptions">
- <summary>
- Represents options for parsing CSV data.
- </summary>
- <remarks>
- An instance of this class can be passed into constructors of <see cref="T:Aspose.Words.Reporting.CsvDataSource" />.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Reporting.CsvDataLoadOptions.#ctor">
- <summary>
- Initializes a new instance of this class with default options.
- </summary>
- </member>
- <member name="M:Aspose.Words.Reporting.CsvDataLoadOptions.#ctor(System.Boolean)">
- <summary>
- Initializes a new instance of this class with specifying whether CSV data contains column names
- at the first line.
- </summary>
- </member>
- <member name="P:Aspose.Words.Reporting.CsvDataLoadOptions.HasHeaders">
- <summary>
- Gets or sets a value indicating whether the first record of CSV data contains column names.
- </summary>
- <remarks>
- The default value is <b>false</b>.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Reporting.CsvDataLoadOptions.Delimiter">
- <summary>
- Gets or sets the character to be used as a column delimiter.
- </summary>
- <remarks>
- The default value is ',' (comma).
- </remarks>
- </member>
- <member name="P:Aspose.Words.Reporting.CsvDataLoadOptions.QuoteChar">
- <summary>
- Gets or sets the character that is used to quote field values.
- </summary>
- <remarks>
- <para>The default value is '"' (quotation mark).</para>
- <para>Double the character to place it into quoted text.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Reporting.CsvDataLoadOptions.CommentChar">
- <summary>
- Gets or sets the character that is used to comment lines of CSV data.
- </summary>
- <remarks>
- The default value is '#' (number sign).
- </remarks>
- </member>
- <member name="T:Aspose.Words.Reporting.CsvDataSource">
- <summary>
- Provides access to data of a CSV file or stream to be used within a report.
- </summary>
- <remarks>
- <para>
- To access data of the corresponding file or stream while generating a report, pass an instance of this class as
- a data source to one of <see cref="T:Aspose.Words.Reporting.ReportingEngine" />.BuildReport overloads.
- </para>
- <para>
- In template documents, a <see cref="T:Aspose.Words.Reporting.CsvDataSource" /> instance should be treated in the same way as if it was
- a <see cref="T:System.Data.DataTable" />
- instance. For more information, see template syntax reference
- (https://docs.aspose.com/display/wordsnet/Template+Syntax).
- </para>
- <para>
- Data types of comma-separated values are determined automatically upon their string representations. So in template
- documents, you can work with typed values rather than just strings. The engine is capable to automatically recognize
- values of the following types:
- </para>
- <list type="bullet">
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.String" />
- </item>
- </list>
- <para>
- Note that for automatic recognition of data types to work, string representations of comma-separated values should
- be formed using invariant culture settings.
- </para>
- <para>
- To override default behavior of CSV data loading, initialize and pass a <see cref="T:Aspose.Words.Reporting.CsvDataLoadOptions" /> instance
- to a constructor of this class.
- </para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Reporting.CsvDataSource.#ctor(System.String)">
- <summary>
- Creates a new data source with data from a CSV file using default options for parsing CSV data.
- </summary>
- <param name="csvPath">The path to the CSV file to be used as the data source.</param>
- </member>
- <member name="M:Aspose.Words.Reporting.CsvDataSource.#ctor(System.String,Aspose.Words.Reporting.CsvDataLoadOptions)">
- <summary>
- Creates a new data source with data from a CSV file using the specified options for parsing CSV data.
- </summary>
- <param name="csvPath">The path to the CSV file to be used as the data source.</param>
- <param name="options">Options for parsing the CSV data.</param>
- </member>
- <member name="M:Aspose.Words.Reporting.CsvDataSource.#ctor(System.IO.Stream)">
- <summary>
- Creates a new data source with data from a CSV stream using default options for parsing CSV data.
- </summary>
- <param name="csvStream">The stream of CSV data to be used as the data source.</param>
- </member>
- <member name="M:Aspose.Words.Reporting.CsvDataSource.#ctor(System.IO.Stream,Aspose.Words.Reporting.CsvDataLoadOptions)">
- <summary>
- Creates a new data source with data from a CSV stream using the specified options for parsing CSV data.
- </summary>
- <param name="csvStream">The stream of CSV data to be used as the data source.</param>
- <param name="options">Options for parsing the CSV data.</param>
- </member>
- <member name="T:Aspose.Words.Reporting.JsonDataLoadOptions">
- <summary>
- Represents options for parsing JSON data.
- </summary>
- <remarks>
- An instance of this class can be passed into constructors of <see cref="T:Aspose.Words.Reporting.JsonDataSource" />.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Reporting.JsonDataLoadOptions.#ctor">
- <summary>
- Initializes a new instance of this class with default options.
- </summary>
- </member>
- <member name="P:Aspose.Words.Reporting.JsonDataLoadOptions.SimpleValueParseMode">
- <summary>
- Gets or sets a mode for parsing JSON simple values (null, boolean, number, integer, and string)
- while loading JSON. Such a mode does not affect parsing of date-time values. The default is
- <see cref="F:Aspose.Words.Reporting.JsonSimpleValueParseMode.Loose" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Reporting.JsonDataLoadOptions.ExactDateTimeParseFormat">
- <summary>
- Gets or sets an exact format for parsing JSON date-time values while loading JSON. The default is <b>null</b>.
- </summary>
- <remarks>
- <para>
- Strings encoded using Microsoft® JSON date-time format (for example, "/Date(1224043200000)/") are always
- recognized as date-time values regardless of a value of this property. The property defines additional
- formats to be used while parsing date-time values from strings in the following way:
- </para>
- <list type="bullet">
- <item>
- When <see cref="P:Aspose.Words.Reporting.JsonDataLoadOptions.ExactDateTimeParseFormat" /> is <b>null</b>, the ISO-8601 format and all date-time formats
- supported for the current, English USA, and English New Zealand cultures are used additionally in
- the mentioned order.
- </item>
- <item>
- When <see cref="P:Aspose.Words.Reporting.JsonDataLoadOptions.ExactDateTimeParseFormat" /> is a non-empty string, it is used as a single additional
- date-time format utilizing the current culture.
- </item>
- <item>
- When <see cref="P:Aspose.Words.Reporting.JsonDataLoadOptions.ExactDateTimeParseFormat" /> is an empty string, no additional date-time formats are used.
- </item>
- </list>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Reporting.JsonDataSource">
- <summary>
- Provides access to data of a JSON file or stream to be used within a report.
- </summary>
- <remarks>
- <para>
- To access data of the corresponding file or stream while generating a report, pass an instance of this class as
- a data source to one of <see cref="T:Aspose.Words.Reporting.ReportingEngine" />.BuildReport overloads.
- </para>
- <para>
- In template documents, if a top-level JSON element is an array, a <see cref="T:Aspose.Words.Reporting.JsonDataSource" /> instance should be
- treated in the same way as if it was a <see cref="T:System.Data.DataTable" /> instance. If a top-level JSON element
- is an object, a <see cref="T:Aspose.Words.Reporting.JsonDataSource" /> instance should be treated in the same way as if it was
- a <see cref="T:System.Data.DataRow" />
- instance. For more information, see template syntax reference
- (https://docs.aspose.com/display/wordsnet/Template+Syntax).
- </para>
- <para>
- In template documents, you can work with typed values of JSON elements. For convenience, the engine replaces the set
- of JSON simple types with the following one:
- </para>
- <list type="bullet">
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.String" />
- </item>
- </list>
- <para>
- The engine automatically recognizes values of the extra types upon their JSON representations.
- </para>
- <para>
- To override default behavior of JSON data loading, initialize and pass a <see cref="T:Aspose.Words.Reporting.JsonDataLoadOptions" /> instance
- to a constructor of this class.
- </para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Reporting.JsonDataSource.#ctor(System.String)">
- <summary>
- Creates a new data source with data from a JSON file using default options for parsing JSON data.
- </summary>
- <param name="jsonPath">The path to the JSON file to be used as the data source.</param>
- </member>
- <member name="M:Aspose.Words.Reporting.JsonDataSource.#ctor(System.IO.Stream)">
- <summary>
- Creates a new data source with data from a JSON stream using default options for parsing JSON data.
- </summary>
- <param name="jsonStream">The stream of JSON data to be used as the data source.</param>
- </member>
- <member name="M:Aspose.Words.Reporting.JsonDataSource.#ctor(System.String,Aspose.Words.Reporting.JsonDataLoadOptions)">
- <summary>
- Creates a new data source with data from a JSON file using the specified options for parsing JSON data.
- </summary>
- <param name="jsonPath">The path to the JSON file to be used as the data source.</param>
- <param name="options">Options for parsing JSON data.</param>
- </member>
- <member name="M:Aspose.Words.Reporting.JsonDataSource.#ctor(System.IO.Stream,Aspose.Words.Reporting.JsonDataLoadOptions)">
- <summary>
- Creates a new data source with data from a JSON stream using the specified options for parsing JSON data.
- </summary>
- <param name="jsonStream">The stream of JSON data to be used as the data source.</param>
- <param name="options">Options for parsing JSON data.</param>
- </member>
- <member name="T:Aspose.Words.Reporting.JsonSimpleValueParseMode">
- <summary>
- 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.
- </summary>
- </member>
- <member name="F:Aspose.Words.Reporting.JsonSimpleValueParseMode.Loose">
- <summary>
- Specifies the mode where types of JSON simple values are determined upon parsing of their string representations.
- For example, the type of 'prop' from the JSON snippet '{ prop: "123" }' is determined as integer in this mode.
- </summary>
- </member>
- <member name="F:Aspose.Words.Reporting.JsonSimpleValueParseMode.Strict">
- <summary>
- Specifies the mode where types of JSON simple values are determined from JSON notation itself.
- For example, the type of 'prop' from the JSON snippet '{ prop: "123" }' is determined as string in this mode.
- </summary>
- </member>
- <member name="T:Aspose.Words.Reporting.XmlDataSource">
- <summary>
- Provides access to data of an XML file or stream to be used within a report.
- </summary>
- <remarks>
- <para>
- To access data of the corresponding file or stream while generating a report, pass an instance of this class as
- a data source to one of <see cref="T:Aspose.Words.Reporting.ReportingEngine" />.BuildReport overloads.
- </para>
- <para>
- In template documents, if a top-level XML element contains only a list of elements of the same type,
- an <see cref="T:Aspose.Words.Reporting.XmlDataSource" /> instance should be treated in the same way as if it was
- a <see cref="T:System.Data.DataTable" />
- instance. Otherwise, an <see cref="T:Aspose.Words.Reporting.XmlDataSource" /> instance should be treated in the same way as if it was
- a <see cref="T:System.Data.DataRow" />
- instance. For more information, see template syntax reference
- (https://docs.aspose.com/display/wordsnet/Template+Syntax).
- </para>
- <para>
- When XML Schema Definition is passed to a constructor of this class, data types of values of simple XML elements
- and attributes are determined according to the schema. So in template documents, you can work with typed values
- rather than just strings.
- </para>
- <para>
- When XML Schema Definition is not passed to a constructor of this class, data types of values of simple XML elements
- and attributes are determined automatically upon their string representations. So in template documents, you can work
- with typed values in this case as well. The engine is capable to automatically recognize values of the following types:
- </para>
- <list type="bullet">
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.Nullable`1" />
- </item>
- <item>
- <see cref="T:System.String" />
- </item>
- </list>
- <para>
- Note that for automatic recognition of data types to work, string representations of values of simple XML elements
- and attributes should be formed using invariant culture settings.
- </para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Reporting.XmlDataSource.#ctor(System.String)">
- <summary>
- Creates a new data source with data from an XML file.
- </summary>
- <param name="xmlPath">The path to the XML file to be used as the data source.</param>
- </member>
- <member name="M:Aspose.Words.Reporting.XmlDataSource.#ctor(System.IO.Stream)">
- <summary>
- Creates a new data source with data from an XML stream.
- </summary>
- <param name="xmlStream">The stream of XML data to be used as the data source.</param>
- </member>
- <member name="M:Aspose.Words.Reporting.XmlDataSource.#ctor(System.String,System.String)">
- <summary>
- Creates a new data source with data from an XML file using an XML Schema Definition file.
- </summary>
- <param name="xmlPath">The path to the XML file to be used as the data source.</param>
- <param name="xmlSchemaPath">The path to the XML Schema Definition file that provides schema for the XML
- file.</param>
- </member>
- <member name="M:Aspose.Words.Reporting.XmlDataSource.#ctor(System.IO.Stream,System.IO.Stream)">
- <summary>
- Creates a new data source with data from an XML stream using an XML Schema Definition stream.
- </summary>
- <param name="xmlStream">The stream of XML data to be used as the data source.</param>
- <param name="xmlSchemaStream">The stream of XML Schema Definition that provides schema for the XML data.</param>
- </member>
- <member name="T:Aspose.Words.Reporting.NamespaceDoc">
- <summary>
- <p>This namespace contains classes of the Aspose.Words' new reporting engine that
- supports report templates marked up with a language based on the LINQ Method Syntax.</p>
- <p>This new reporting engine is more advanced than the original mail merge reporting engine
- <see cref="N:Aspose.Words.MailMerging" /> and allows to retrieve data from any .NET class,
- perform grouping, sorting, joining and interpret C# expressions.</p>
- <seealso cref="N:Aspose.Words.MailMerging" />
- </summary>
- </member>
- <member name="T:Aspose.Words.Reporting.ReportBuildOptions">
- <summary>
- Specifies options controlling behavior of <see cref="T:Aspose.Words.Reporting.ReportingEngine" /> while building a report.
- </summary>
- </member>
- <member name="F:Aspose.Words.Reporting.ReportBuildOptions.None">
- <summary>
- Specifies default options.
- </summary>
- </member>
- <member name="F:Aspose.Words.Reporting.ReportBuildOptions.AllowMissingMembers">
- <summary>
- Specifies that missing object members should be treated as null literals by the engine. This option
- affects only access to instance (that is, non-static) object members and extension methods. If this
- option is not set, the engine throws an exception when encounters a missing object member.
- </summary>
- </member>
- <member name="F:Aspose.Words.Reporting.ReportBuildOptions.RemoveEmptyParagraphs">
- <summary>
- Specifies that the engine should remove paragraphs becoming empty after template syntax tags are
- removed or replaced with empty values.
- </summary>
- </member>
- <member name="F:Aspose.Words.Reporting.ReportBuildOptions.InlineErrorMessages">
- <summary>
- Specifies that the engine should inline template syntax error messages into output documents.
- If this option is not set, the engine throws an exception when encounters a syntax error.
- </summary>
- </member>
- <member name="T:Aspose.Words.Reporting.ReportingEngine">
- <summary>
- Provides routines to populate template documents with data and a set of settings to control these routines.
- </summary>
- <dev>
- This class is just a facade of <see cref="T:Aspose.Reporting.ReportingEngineCore" />. Descriptional comments of these classes
- should be kept in sync.
- </dev>
- </member>
- <member name="M:Aspose.Words.Reporting.ReportingEngine.#ctor">
- <summary>
- Initializes a new instance of this class.
- </summary>
- </member>
- <member name="M:Aspose.Words.Reporting.ReportingEngine.BuildReport(Aspose.Words.Document,System.Object)">
- <summary>
- Populates the specified template document with data from the specified source making it a ready report.
- </summary>
- <remarks>
- <para>
- Using this overload you can reference the data source's members in the template document, but you cannot
- reference the data source object itself. You should use the <see cref="M:Aspose.Words.Reporting.ReportingEngine.BuildReport(Aspose.Words.Document,System.Object,System.String)" />
- overload to achieve this.
- </para>
- <para>
- A data source object can be of one of the following types:
- </para>
- <list type="bullet">
- <item>
- <see cref="T:Aspose.Words.Reporting.XmlDataSource" />
- </item>
- <item>
- <see cref="T:Aspose.Words.Reporting.JsonDataSource" />
- </item>
- <item>
- <see cref="T:Aspose.Words.Reporting.CsvDataSource" />
- </item>
- <item>
- <see cref="T:System.Data.DataSet" />
- </item>
- <item>
- <see cref="T:System.Data.DataTable" />
- </item>
- <item>
- <see cref="T:System.Data.DataRow" />
- </item>
- <item>
- <see cref="T:System.Data.IDataReader" />
- </item>
- <item>
- <see cref="T:System.Data.IDataRecord" />
- </item>
- <item>
- <see cref="T:System.Data.DataView" />
- </item>
- <item>
- <see cref="T:System.Data.DataRowView" />
- </item>
- <item>
- Any other arbitrary non-dynamic and non-anonymous .NET type
- </item>
- </list>
- <para>
- For information on how to work with data sources of different types in template documents, see template syntax
- reference (https://docs.aspose.com/display/wordsnet/Template+Syntax).
- </para>
- </remarks>
- <param name="document">A template document to be populated with data.</param>
- <param name="dataSource">A data source object.</param>
- <returns>A flag indicating whether parsing of the template document was successful.
- The returned flag makes sense only if a value of the <see cref="P:Aspose.Words.Reporting.ReportingEngine.Options" /> property includes
- the <see cref="F:Aspose.Words.Reporting.ReportBuildOptions.InlineErrorMessages" /> option.</returns>
- </member>
- <member name="M:Aspose.Words.Reporting.ReportingEngine.BuildReport(Aspose.Words.Document,System.Object,System.String)">
- <summary>
- Populates the specified template document with data from the specified source making it a ready report.
- </summary>
- <remarks>
- <para>
- Using this overload you can reference the data source's members and the data source object itself in the template.
- If you are not going to reference the data source object itself, you can omit <paramref name="dataSourceName" />
- passing null or use the <see cref="M:Aspose.Words.Reporting.ReportingEngine.BuildReport(Aspose.Words.Document,System.Object)" /> overload.
- </para>
- <para>
- A data source object can be of one of the following types:
- </para>
- <list type="bullet">
- <item>
- <see cref="T:Aspose.Words.Reporting.XmlDataSource" />
- </item>
- <item>
- <see cref="T:Aspose.Words.Reporting.JsonDataSource" />
- </item>
- <item>
- <see cref="T:Aspose.Words.Reporting.CsvDataSource" />
- </item>
- <item>
- <see cref="T:System.Data.DataSet" />
- </item>
- <item>
- <see cref="T:System.Data.DataTable" />
- </item>
- <item>
- <see cref="T:System.Data.DataRow" />
- </item>
- <item>
- <see cref="T:System.Data.IDataReader" />
- </item>
- <item>
- <see cref="T:System.Data.IDataRecord" />
- </item>
- <item>
- <see cref="T:System.Data.DataView" />
- </item>
- <item>
- <see cref="T:System.Data.DataRowView" />
- </item>
- <item>
- Any other arbitrary non-dynamic and non-anonymous .NET type
- </item>
- </list>
- <para>
- For information on how to work with data sources of different types in template documents, see template syntax
- reference (https://docs.aspose.com/display/wordsnet/Template+Syntax).
- </para>
- </remarks>
- <param name="document">A template document to be populated with data.</param>
- <param name="dataSource">A data source object.</param>
- <param name="dataSourceName">A name to reference the data source object in the template.</param>
- <returns>A flag indicating whether parsing of the template document was successful.
- The returned flag makes sense only if a value of the <see cref="P:Aspose.Words.Reporting.ReportingEngine.Options" /> property includes
- the <see cref="F:Aspose.Words.Reporting.ReportBuildOptions.InlineErrorMessages" /> option.</returns>
- </member>
- <member name="M:Aspose.Words.Reporting.ReportingEngine.BuildReport(Aspose.Words.Document,System.Object[],System.String[])">
- <summary>
- Populates the specified template document with data from the specified sources making it a ready report.
- </summary>
- <remarks>
- <para>
- Using this overload you can reference multiple data source objects and their members in the template.
- The name of the first data source can be omitted (i.e. be an empty string or null) if you are going to
- reference the data source's members but not the data source object itself. Names of the other data sources
- must be specified and unique.
- </para>
- <para>
- If you are going to use a single data source, consider using of <see cref="M:Aspose.Words.Reporting.ReportingEngine.BuildReport(Aspose.Words.Document,System.Object)" />
- and <see cref="M:Aspose.Words.Reporting.ReportingEngine.BuildReport(Aspose.Words.Document,System.Object,System.String)" /> overloads instead.
- </para>
- <para>
- A data source object can be of one of the following types:
- </para>
- <list type="bullet">
- <item>
- <see cref="T:Aspose.Words.Reporting.XmlDataSource" />
- </item>
- <item>
- <see cref="T:Aspose.Words.Reporting.JsonDataSource" />
- </item>
- <item>
- <see cref="T:Aspose.Words.Reporting.CsvDataSource" />
- </item>
- <item>
- <see cref="T:System.Data.DataSet" />
- </item>
- <item>
- <see cref="T:System.Data.DataTable" />
- </item>
- <item>
- <see cref="T:System.Data.DataRow" />
- </item>
- <item>
- <see cref="T:System.Data.IDataReader" />
- </item>
- <item>
- <see cref="T:System.Data.IDataRecord" />
- </item>
- <item>
- <see cref="T:System.Data.DataView" />
- </item>
- <item>
- <see cref="T:System.Data.DataRowView" />
- </item>
- <item>
- Any other arbitrary non-dynamic and non-anonymous .NET type
- </item>
- </list>
- <para>
- For information on how to work with data sources of different types in template documents, see template syntax
- reference (https://docs.aspose.com/display/wordsnet/Template+Syntax).
- </para>
- </remarks>
- <param name="document">A template document to be populated with data.</param>
- <param name="dataSources">An array of data source objects.</param>
- <param name="dataSourceNames">An array of names to reference the data source objects within the template.</param>
- <returns>A flag indicating whether parsing of the template document was successful.
- The returned flag makes sense only if a value of the <see cref="P:Aspose.Words.Reporting.ReportingEngine.Options" /> property includes
- the <see cref="F:Aspose.Words.Reporting.ReportBuildOptions.InlineErrorMessages" /> option.</returns>
- </member>
- <member name="P:Aspose.Words.Reporting.ReportingEngine.Options">
- <summary>
- Gets or sets a set of flags controlling behavior of this <see cref="T:Aspose.Words.Reporting.ReportingEngine" /> instance
- while building a report.
- </summary>
- </member>
- <member name="P:Aspose.Words.Reporting.ReportingEngine.KnownTypes">
- <summary>
- Gets an unordered set (i.e. a collection of unique items) containing <see cref="T:System.Type" /> objects
- which fully or partially qualified names can be used within report templates processed by this engine
- instance to invoke the corresponding types' static members, perform type casts, etc.
- </summary>
- </member>
- <member name="P:Aspose.Words.Reporting.ReportingEngine.UseReflectionOptimization">
- <summary>
- Gets or sets a value indicating whether invocations of custom type members performed via reflection API are
- optimized using dynamic class generation or not. The default value is true.
- </summary>
- <remarks>
- There are some scenarios where it is preferrable to disable this optimization. For example, if you are dealing
- with small collections of data items all the time, then an overhead of dynamic class generation can be more
- noticeable than an overhead of direct reflection API calls.
- </remarks>
- <dev>
- Normally, such settings should be located in configuration files, but it seems like there is no autoportable way
- to achieve this.
- </dev>
- </member>
- <member name="T:Aspose.Words.Reporting.KnownTypeSet">
- <summary>
- Represents an unordered set (i.e. a collection of unique items) containing <see cref="T:System.Type" /> objects
- which fully or partially qualified names can be used within report templates to invoke the corresponding
- types' static members, perform type casts, etc.
- </summary>
- <dev>
- This class is just a facade of <see cref="T:Aspose.Reporting.KnownTypeSetCore" />. Descriptional comments of these classes
- should be kept in sync.
- </dev>
- </member>
- <member name="M:Aspose.Words.Reporting.KnownTypeSet.Add(System.Type)">
- <summary>
- <para>Adds the specified <see cref="T:System.Type" /> object to the set. Throws <see cref="T:System.ArgumentException" /> in
- the following cases:</para>
- <para>- <paramref name="type" /> is null.</para>
- <para>- <paramref name="type" /> represents a void type.</para>
- <para>- <paramref name="type" /> represents an invisible type, i.e. a non-public type or a public nested type
- which has a non-public outer type.</para>
- <para>- <paramref name="type" /> represents a generic type.</para>
- <para>- <paramref name="type" /> represents an array type.</para>
- <para>- <paramref name="type" /> has been added to the set already.</para>
- </summary>
- <param name="type">A <see cref="T:System.Type" /> object to add.</param>
- </member>
- <member name="M:Aspose.Words.Reporting.KnownTypeSet.Remove(System.Type)">
- <summary>
- Removes the specified <see cref="T:System.Type" /> object from the set. Throws <see cref="T:System.ArgumentException" /> if
- <paramref name="type" /> is null.
- </summary>
- <param name="type">A <see cref="T:System.Type" /> object to remove.</param>
- </member>
- <member name="M:Aspose.Words.Reporting.KnownTypeSet.Clear">
- <summary>
- Removes all items from the set.
- </summary>
- </member>
- <member name="M:Aspose.Words.Reporting.KnownTypeSet.GetEnumerator">
- <summary>
- Returns An <see cref="T:System.Collections.IEnumerator" /> object to iterate over items of the set.
- </summary>
- <returns>An <see cref="T:System.Collections.IEnumerator" /> object to iterate over items of the set.</returns>
- </member>
- <member name="P:Aspose.Words.Reporting.KnownTypeSet.Count">
- <summary>
- Gets the count of items in the set.
- </summary>
- </member>
- <member name="T:Aspose.Words.WebExtensions.BaseWebExtensionCollection`1">
- <summary>
- Base class for <see cref="T:Aspose.Words.WebExtensions.TaskPaneCollection" />, <see cref="T:Aspose.Words.WebExtensions.WebExtensionBindingCollection" />,
- <see cref="T:Aspose.Words.WebExtensions.WebExtensionPropertyCollection" /> and <see cref="T:Aspose.Words.WebExtensions.WebExtensionReferenceCollection" /> collections.
- </summary>
- <typeparam name="T">Type of a collection item.</typeparam>
- </member>
- <member name="M:Aspose.Words.WebExtensions.BaseWebExtensionCollection`1.Add(`0)">
- <summary>
- Adds specified item to the collection.
- </summary>
- <param name="item">Item for adding.</param>
- </member>
- <member name="M:Aspose.Words.WebExtensions.BaseWebExtensionCollection`1.Clear">
- <summary>
- Removes all elements from the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.WebExtensions.BaseWebExtensionCollection`1.Remove(System.Int32)">
- <summary>
- Removes the item at the specified index from the collection.
- </summary>
- <param name="index">The zero-based index of the collection item.</param>
- </member>
- <member name="M:Aspose.Words.WebExtensions.BaseWebExtensionCollection`1.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through a collection.
- </summary>
- <returns>
- </returns>
- </member>
- <member name="P:Aspose.Words.WebExtensions.BaseWebExtensionCollection`1.Count">
- <summary>
- Gets the number of elements contained in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.BaseWebExtensionCollection`1.Item(System.Int32)">
- <summary>
- Gets or sets an item at the specified index.
- </summary>
- <param name="index">Zero-based index of the item.</param>
- </member>
- <member name="T:Aspose.Words.WebExtensions.WebExtensionReferenceCollection">
- <summary>
- Specifies a list of web extension references.
- </summary>
- <dev>2.2.6 CT_OsfWebExtensionReferenceList</dev>
- </member>
- <member name="T:Aspose.Words.WebExtensions.WebExtensionBindingCollection">
- <summary>
- Specifies a list of web extension bindings.
- </summary>
- <dev>2.2.4 CT_OsfWebExtensionBindingList</dev>
- </member>
- <member name="T:Aspose.Words.WebExtensions.WebExtensionPropertyCollection">
- <summary>
- Specifies a set of web extension custom properties.
- </summary>
- <dev>2.2.2 CT_OsfWebExtensionPropertyBag</dev>
- </member>
- <member name="T:Aspose.Words.WebExtensions.WebExtensionBindingType">
- <summary>
- Enumerates available types of binding between a web extension and the data in the document.
- </summary>
- <dev>https://docs.microsoft.com/en-us/javascript/api/office/office.bindingtype?view=office-js</dev>
- </member>
- <member name="F:Aspose.Words.WebExtensions.WebExtensionBindingType.Matrix">
- <summary>
- Tabular data without a header row.
- </summary>
- </member>
- <member name="F:Aspose.Words.WebExtensions.WebExtensionBindingType.Table">
- <summary>
- Tabular data with a header row.
- </summary>
- </member>
- <member name="F:Aspose.Words.WebExtensions.WebExtensionBindingType.Text">
- <summary>
- Plain text.
- </summary>
- </member>
- <member name="T:Aspose.Words.WebExtensions.WebExtensionStoreType">
- <summary>
- Enumerates available types of a web extension store.
- </summary>
- </member>
- <member name="F:Aspose.Words.WebExtensions.WebExtensionStoreType.SPCatalog">
- <summary>
- Specifies that the store type is SharePoint corporate catalog.
- </summary>
- </member>
- <member name="F:Aspose.Words.WebExtensions.WebExtensionStoreType.OMEX">
- <summary>
- Specifies that the store type is Office.com.
- </summary>
- </member>
- <member name="F:Aspose.Words.WebExtensions.WebExtensionStoreType.SPApp">
- <summary>
- Specifies that the store type is a SharePoint web application.
- </summary>
- </member>
- <member name="F:Aspose.Words.WebExtensions.WebExtensionStoreType.Exchange">
- <summary>
- Specifies that the store type is an Exchange server.
- </summary>
- </member>
- <member name="F:Aspose.Words.WebExtensions.WebExtensionStoreType.FileSystem">
- <summary>
- Specifies that the store type is a file system share.
- </summary>
- </member>
- <member name="F:Aspose.Words.WebExtensions.WebExtensionStoreType.Registry">
- <summary>
- Specifies that the store type is the system registry.
- </summary>
- </member>
- <member name="F:Aspose.Words.WebExtensions.WebExtensionStoreType.ExCatalog">
- <summary>
- Specifies that the store type is Centralized Deployment via Exchange.
- </summary>
- </member>
- <member name="F:Aspose.Words.WebExtensions.WebExtensionStoreType.Default">
- <summary>
- Default value.
- </summary>
- </member>
- <member name="T:Aspose.Words.WebExtensions.NamespaceDoc">
- <summary>
- <para>The <b>Aspose.Words.WebExtensions</b> namespace provides classes that allow to
- customize elements and attributes that extend the XML vocabulary for representing Office Add-ins.</para>
- </summary>
- </member>
- <member name="T:Aspose.Words.WebExtensions.TaskPane">
- <summary>
- Represents an add-in task pane object.
- </summary>
- <dev>2.2.8 CT_OsfTaskpane. This essence has public constructor.</dev>
- </member>
- <member name="P:Aspose.Words.WebExtensions.TaskPane.Row">
- <summary>
- Specifies the index, enumerating from the outside to the inside, of this task pane among other persisted
- task panes docked in the same default location.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.TaskPane.Width">
- <summary>
- Specifies the default width value for this task pane instance.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.TaskPane.IsLocked">
- <summary>
- Specifies whether the task pane is locked to the document in the UI and cannot be closed by the user.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.TaskPane.IsVisible">
- <summary>
- Specifies whether the task pane shows as visible by default when the document opens.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.TaskPane.DockState">
- <summary>
- Specifies the last-docked location of this task pane object.
- </summary>
- <dev>In the spec this value represents as string.</dev>
- </member>
- <member name="P:Aspose.Words.WebExtensions.TaskPane.WebExtension">
- <summary>
- Represents an web extension object.
- </summary>
- </member>
- <member name="T:Aspose.Words.WebExtensions.TaskPaneCollection">
- <summary>
- Specifies a list of persisted task pane objects.
- </summary>
- <dev>2.2.9 CT_OsfTaskpanes</dev>
- </member>
- <member name="T:Aspose.Words.WebExtensions.TaskPaneDockState">
- <summary>
- Enumerates available locations of task pane object.
- </summary>
- <dev>"top", "bottom", "fill" do not work. Add more available values upon request.</dev>
- </member>
- <member name="F:Aspose.Words.WebExtensions.TaskPaneDockState.Right">
- <summary>
- Dock the task pane on the right side of the document window.
- </summary>
- </member>
- <member name="F:Aspose.Words.WebExtensions.TaskPaneDockState.Left">
- <summary>
- Dock the task pane on the left side of the document window.
- </summary>
- </member>
- <member name="T:Aspose.Words.WebExtensions.WebExtension">
- <summary>
- Represents a web extension object.
- </summary>
- <dev>2.2.7 CT_OsfWebExtension</dev>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtension.Id">
- <summary>
- Uniquely identifies the web extension instance in the current document.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtension.IsFrozen">
- <summary>
- Specifies whether the user can interact with the web extension or not.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtension.Reference">
- <summary>
- Specifies the primary reference to an web extension.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtension.Bindings">
- <summary>
- Specifies a list of web extension bindings.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtension.AlternateReferences">
- <summary>
- Specifies alternate references to a web extension.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtension.Properties">
- <summary>
- Represents a set of web extension custom properties.
- </summary>
- </member>
- <member name="T:Aspose.Words.WebExtensions.WebExtensionBinding">
- <summary>
- Specifies a binding relationship between a web extension and the data in the document.
- </summary>
- <dev>2.2.3 CT_OsfWebExtensionBinding</dev>
- </member>
- <member name="M:Aspose.Words.WebExtensions.WebExtensionBinding.#ctor">
- <summary>
- Hide default ctr.
- </summary>
- </member>
- <member name="M:Aspose.Words.WebExtensions.WebExtensionBinding.#ctor(System.String,Aspose.Words.WebExtensions.WebExtensionBindingType,System.String)">
- <summary>
- Creates web extension binding with specified parameters.
- </summary>
- <param name="id">Binding identifier.</param>
- <param name="bindingType">Binding type.</param>
- <param name="appRef">Binding key used to map the binding entry in this list with the bound data in the document.</param>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtensionBinding.Id">
- <summary>
- Specifies the binding identifier.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtensionBinding.BindingType">
- <summary>
- Specifies the binding type.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtensionBinding.AppRef">
- <summary>
- Specifies the binding key used to map the binding entry in this list with the bound data in the document.
- </summary>
- <dev>It may be, for example, identifier of the SDT.</dev>
- </member>
- <member name="T:Aspose.Words.WebExtensions.WebExtensionProperty">
- <summary>
- Specifies a web extension custom property.
- </summary>
- <dev>2.2.1 CT_OsfWebExtensionProperty</dev>
- </member>
- <member name="M:Aspose.Words.WebExtensions.WebExtensionProperty.#ctor">
- <summary>
- Hide default ctr.
- </summary>
- </member>
- <member name="M:Aspose.Words.WebExtensions.WebExtensionProperty.#ctor(System.String,System.String)">
- <summary>
- Creates web extension custom property with specified name and value.
- </summary>
- <param name="name">Property name.</param>
- <param name="value">Property value.</param>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtensionProperty.Name">
- <summary>
- Specifies a custom property name
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtensionProperty.Value">
- <summary>
- Specifies a custom property value.
- </summary>
- </member>
- <member name="T:Aspose.Words.WebExtensions.WebExtensionReference">
- <summary>
- Represents the reference to a web extension. The reference is used to identify the provider location and version of the
- extension.
- </summary>
- <dev>2.2.5 CT_OsfWebExtensionReference. This essence has public constructor to provide ability to populate alternate references.</dev>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtensionReference.Id">
- <summary>
- Identifier associated with the web extension within a catalog provider.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtensionReference.Version">
- <summary>
- Specifies the version of the web extension.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtensionReference.Store">
- <summary>
- Specifies the instance of the marketplace where the web extension is stored.
- </summary>
- </member>
- <member name="P:Aspose.Words.WebExtensions.WebExtensionReference.StoreType">
- <summary>
- Specifies the type of marketplace.
- </summary>
- </member>
- <member name="T:Aspose.Words.Themes.NamespaceDoc">
- <summary>
- <para>The <b>Aspose.Words.Themes</b> namespace provides classes that allow to access theme information in Microsoft Word documents.</para>
- <para>A document theme can specify fonts and colors to be used in a document. Themes are supported in Word 2007 and higher.</para>
- </summary>
- </member>
- <member name="T:Aspose.Words.Themes.ThemeColors">
- <summary>
- <p>Represents the color scheme of the document theme which contains twelve colors.</p>
- <p>ThemeColors object contains six accent colors, two dark colors, two light colors
- and a color for each of a hyperlink and followed hyperlink.</p>
- </summary>
- <dev>
- 20.1.6.2 clrScheme (Color Scheme)
- Defines a set of colors which are referred to as a color scheme. The The Color Scheme Color elements appear in a sequence.
- </dev>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeColors.Accent1">
- <summary>
- Specifies color Accent 1.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeColors.Accent2">
- <summary>
- Specifies color Accent 2.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeColors.Accent3">
- <summary>
- Specifies color Accent 3.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeColors.Accent4">
- <summary>
- Specifies color Accent 4.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeColors.Accent5">
- <summary>
- Specifies color Accent 5.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeColors.Accent6">
- <summary>
- Specifies color Accent 6.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeColors.Dark1">
- <summary>
- Specifies color Dark 1.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeColors.Dark2">
- <summary>
- Specifies color Dark 2.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeColors.FollowedHyperlink">
- <summary>
- Specifies color for a clicked hyperlink.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeColors.Hyperlink">
- <summary>
- Specifies color for a hyperlink.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeColors.Light1">
- <summary>
- Specifies color Light 1.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeColors.Light2">
- <summary>
- Specifies color Light 2.
- </summary>
- </member>
- <member name="T:Aspose.Words.Themes.Theme">
- <summary>
- Represents document Theme, and provides access to main theme parts including <see cref="P:Aspose.Words.Themes.Theme.MajorFonts" />, <see cref="P:Aspose.Words.Themes.Theme.MinorFonts" /> and <see cref="P:Aspose.Words.Themes.Theme.Colors" /></summary>
- <dev>
- At the moment this is just a crude hack to preserve themes during DOCX to DOCX roundtrip,
- but later should be worked into a more appropriate object.
-
- WORDSNET-10513. Limited support for theme handling was implemented.
- If customer changes one of theme part then theme is rewritten with new values.
- If theme is unchanged during roundtrip then it is written raw as before.
- </dev>
- </member>
- <member name="P:Aspose.Words.Themes.Theme.MajorFonts">
- <summary>
- Allows to specify the set of major fonts for different languages.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.Theme.MinorFonts">
- <summary>
- Allows to specify the set of minor fonts for different languages.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.Theme.Colors">
- <summary>
- Allows to specify the set of theme colors for the document.
- </summary>
- </member>
- <member name="T:Aspose.Words.Themes.ThemeFonts">
- <summary>
- Represents a collection of fonts in the font scheme, allowing to specify different fonts for different languages <see cref="P:Aspose.Words.Themes.ThemeFonts.Latin" />, <see cref="P:Aspose.Words.Themes.ThemeFonts.EastAsian" /> and <see cref="P:Aspose.Words.Themes.ThemeFonts.ComplexScript" />.
- </summary>
- <dev>
- Corresponds to 5.1.4.1.24 majorFont (Major Font) or 5.1.4.1.25 minorFont (Minor fonts).
- </dev>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeFonts.Latin">
- <summary>
- Specifies font name for Latin characters.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeFonts.EastAsian">
- <summary>
- Specifies font name for EastAsian characters.
- </summary>
- </member>
- <member name="P:Aspose.Words.Themes.ThemeFonts.ComplexScript">
- <summary>
- Specifies font name for ComplexScript characters.
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.TextWrapping">
- <summary>
- Specifies how text is wrapped around the table.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.TextWrapping.None">
- <summary>
- Text and table is displayed in the order of their appearance in the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.TextWrapping.Around">
- <summary>
- Text is wrapped around the table occupying available side space.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.TextWrapping.Default">
- <summary>
- Default value.
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.AutoFitBehavior">
- <summary>
- Determines how Aspose.Words resizes the table when you invoke the <see cref="M:Aspose.Words.Tables.Table.AutoFit(Aspose.Words.Tables.AutoFitBehavior)" /> method.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.AutoFitBehavior.AutoFitToContents">
- <summary>
- <para>Aspose.Words enables the AutoFit option, removes the preferred width from the table and all cells and then updates the table layout.</para>
- <para>In the resulting table, cell widths are updated to fit the table contents. Most likely, the table will shrink.</para>
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.AutoFitBehavior.AutoFitToWindow">
- <summary>
- <para>When you use this value, Aspose.Words enables the AutoFit option, sets the preferred width for the table to 100%,
- removes preferred widths from all cells and then updates the table layout.</para>
- <para>As a result, the table occupies all available width and the cell widths are updated to fit table contents.</para>
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.AutoFitBehavior.FixedColumnWidths">
- <summary>
- <para>Aspose.Words disables the AutoFit option and removes the preferred with from the table.</para>
- <para>The widths of the cells remain as they are specified by their <see cref="P:Aspose.Words.Tables.CellFormat.Width" /> properties.</para>
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.TableAlignment">
- <summary>
- Specifies alignment for an inline table.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.TableAlignment.Left">
- <summary>
- The table is aligned to the left.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.TableAlignment.Center">
- <summary>
- The table is centered.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.TableAlignment.Right">
- <summary>
- The table is aligned to the right.
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.PreferredWidth">
- <summary>
- Represents a value and its unit of measure that is used to specify the preferred width of a table or a cell.
- </summary>
- <remarks>
- <para>Preferred width can be specified as a percentage, number of points or a special "none/auto" value.</para>
- <para>The instances of this class are immutable.</para>
- <seealso cref="P:Aspose.Words.Tables.Table.PreferredWidth" />
- <seealso cref="P:Aspose.Words.Tables.CellFormat.PreferredWidth" />
- </remarks>
- </member>
- <member name="F:Aspose.Words.Tables.PreferredWidth.Auto">
- <summary>
- Returns an instance that represents the "preferred width is not specified" value.
- </summary>
- </member>
- <member name="M:Aspose.Words.Tables.PreferredWidth.FromPercent(System.Double)">
- <summary>
- A creation method that returns a new instance that represents a preferred width specified as a percentage.
- </summary>
- <param name="percent">The value must be from 0 to 100.</param>
- </member>
- <member name="M:Aspose.Words.Tables.PreferredWidth.FromPoints(System.Double)">
- <summary>
- A creation method that returns a new instance that represents a preferred width specified using a number of points.
- </summary>
- <param name="points">The value must be from 0 to 22 inches (22 * 72 points).</param>
- </member>
- <member name="M:Aspose.Words.Tables.PreferredWidth.Equals(Aspose.Words.Tables.PreferredWidth)">
- <summary>
- Determines whether the specified PreferredWidth is equal in value to the current PreferredWidth.
- </summary>
- </member>
- <member name="M:Aspose.Words.Tables.PreferredWidth.Equals(System.Object)">
- <summary>
- Determines whether the specified object is equal in value to the current object.
- </summary>
- </member>
- <member name="M:Aspose.Words.Tables.PreferredWidth.GetHashCode">
- <summary>
- Serves as a hash function for this type.
- </summary>
- </member>
- <member name="M:Aspose.Words.Tables.PreferredWidth.ToString">
- <summary>
- Returns a user-friendly string that displays the value of this object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.PreferredWidth.Type">
- <summary>
- Gets the unit of measure used for this preferred width value.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.PreferredWidth.Value">
- <summary>
- Gets the preferred width value. The unit of measure is specified in the <see cref="P:Aspose.Words.Tables.PreferredWidth.Type" /> property.
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.PreferredWidthType">
- <summary>
- Specifies the unit of measurement for the preferred width of a table or cell.
- </summary>
- <seealso cref="T:Aspose.Words.Tables.PreferredWidth" />
- </member>
- <member name="F:Aspose.Words.Tables.PreferredWidthType.Auto">
- <summary>
- The preferred width is not specified. The actual width of the table or cell is either specified using the explicit width or
- will be determined automatically by the table layout algorithm when the table is displayed, depending on the table auto fit setting.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.PreferredWidthType.Percent">
- <summary>
- Measure the current item width using a specified percentage.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.PreferredWidthType.Points">
- <summary>
- Measure the current item width using a specified number of points (1/72 inch).
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.TableStyleOptions">
- <summary>
- Specifies how table style is applied to a table.
- </summary>
- <seealso cref="P:Aspose.Words.Tables.Table.StyleOptions" />
- <dev>
- 2.4.51 tblLook (Table Style Conditional Formatting Settings)
- The DOC spec defines more values here, but it says they are ignored by Word 2007 so we ignore them too.
- </dev>
- </member>
- <member name="F:Aspose.Words.Tables.TableStyleOptions.None">
- <summary>
- No table style formatting is applied.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.TableStyleOptions.FirstRow">
- <summary>
- Apply first row conditional formatting.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.TableStyleOptions.LastRow">
- <summary>
- Apply last row conditional formatting.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.TableStyleOptions.FirstColumn">
- <summary>
- Apply 1 first column conditional formatting.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.TableStyleOptions.LastColumn">
- <summary>
- Apply last column conditional formatting.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.TableStyleOptions.RowBands">
- <summary>
- Apply row banding conditional formatting.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.TableStyleOptions.ColumnBands">
- <summary>
- Apply column banding conditional formatting.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.TableStyleOptions.Default2003">
- <summary>
- Row and column banding is applied. This is Microsoft Word default for old formats such as DOC, WML and RTF.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.TableStyleOptions.Default">
- <summary>
- This is Microsoft Word defaults.
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.Cell">
- <summary>
- Represents a table cell.
- </summary>
- <remarks>
- <p>
- <b>Cell</b> can only be a child of a <b>Row</b>.</p>
- <p>
- <b>Cell</b> can contain block-level nodes <b>Paragraph</b> and <b>Table</b>.</p>
- <p>A minimal valid cell needs to have at least one <b>Paragraph</b>.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Tables.Cell.#ctor(Aspose.Words.DocumentBase)">
- <summary>
- Initializes a new instance of the <b>Cell</b> class.
- </summary>
- <remarks>
- <p>When <b>Cell</b> is created, it belongs to the specified document, but is not
- yet part of the document and <b>ParentNode</b> is null.</p>
- <p>To append <b>Cell</b> to the document use InsertAfter or InsertBefore
- on the row where you want the cell inserted.</p>
- </remarks>
- <param name="doc">The owner document.</param>
- </member>
- <member name="M:Aspose.Words.Tables.Cell.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls DocumentVisitor.VisitCellStart, then calls Accept for all child nodes of the section
- and calls DocumentVisitor.VisitCellEnd at the end.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Tables.Cell.EnsureMinimum">
- <summary>
- If the last child is not a paragraph, creates and appends one empty paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Cell.NodeType">
- <summary>
- Returns <b>NodeType.Cell</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Cell.ParentRow">
- <summary>
- Returns the parent row of the cell.
- </summary>
- <remarks>Equivalent to <c>(Row)FirstNonMarkupParentNode</c>.</remarks>
- </member>
- <member name="P:Aspose.Words.Tables.Cell.FirstParagraph">
- <summary>
- Gets the first paragraph among the immediate children.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Cell.LastParagraph">
- <summary>
- Gets the last paragraph among the immediate children.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Cell.IsFirstCell">
- <summary>
- True if this is the first cell inside a row; false otherwise.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Cell.IsLastCell">
- <summary>
- True if this is the last cell inside a row; false otherwise.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Cell.CellFormat">
- <summary>
- Provides access to the formatting properties of the cell.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Cell.Paragraphs">
- <summary>
- Gets a collection of paragraphs that are immediate children of the cell.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Cell.Tables">
- <summary>
- Gets a collection of tables that are immediate children of the cell.
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.CellFormat">
- <summary>
- Represents all formatting for a table cell.
- </summary>
- </member>
- <member name="M:Aspose.Words.Tables.CellFormat.ClearFormatting">
- <summary>
- Resets to default cell formatting. Does not change the width of the cell.
- </summary>
- </member>
- <member name="M:Aspose.Words.Tables.CellFormat.SetPaddings(System.Double,System.Double,System.Double,System.Double)">
- <summary>
- Sets the amount of space (in points) to add to the left/top/right/bottom of the contents of cell.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.CellFormat.LeftPadding">
- <summary>
- Returns or sets the amount of space (in points) to add to the left of the contents of cell.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.CellFormat.RightPadding">
- <summary>
- Returns or sets the amount of space (in points) to add to the right of the contents of cell.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.CellFormat.TopPadding">
- <summary>
- Returns or sets the amount of space (in points) to add above the contents of cell.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.CellFormat.BottomPadding">
- <summary>
- Returns or sets the amount of space (in points) to add below the contents of cell.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.CellFormat.Borders">
- <summary>
- Gets collection of borders of the cell.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.CellFormat.Shading">
- <summary>
- Returns a Shading object that refers to the shading formatting for the cell.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.CellFormat.VerticalAlignment">
- <summary>
- Returns or sets the vertical alignment of text in the cell.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.CellFormat.Width">
- <summary>
- Gets the width of the cell in points.
- </summary>
- <remarks>
- <para>
- The width is calculated by Aspose.Words on document loading and saving.
- Currently, not every combination of table, cell and document properties is supported.
- The returned value may not be accurate for some documents.
- It may not exactly match the cell width as calculated by MS Word when the document is opened in MS Word.
- </para>
- <para>
- Setting this property is not recommended.
- There is no guarantee that the cell will actually have the set width.
- The width may be adjusted to accommodate cell contents in an auto-fit table layout.
- Cells in other rows may have conflicting width settings.
- The table may be resized to fit into the container or to meet table width settings.
- Consider using <see cref="P:Aspose.Words.Tables.CellFormat.PreferredWidth" /> for setting the cell width.
- Setting this property sets <see cref="P:Aspose.Words.Tables.CellFormat.PreferredWidth" /> implicitly since version 15.8.
- </para>
- <seealso cref="P:Aspose.Words.Tables.CellFormat.PreferredWidth" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Tables.CellFormat.PreferredWidth">
- <summary>
- Returns or sets the preferred width of the cell.
- </summary>
- <remarks>
- <para>The preferred width (along with the table's Auto Fit option) determines how the actual
- width of the cell is calculated by the table layout algorithm. Table layout can be performed by
- Aspose.Words when it saves the document or by Microsoft Word when it displays the document.</para>
- <para>The preferred width can be specified in points or in percent. The preferred width
- can also be specified as "auto", which means no preferred width is specified.</para>
- <para>The default value is <see cref="F:Aspose.Words.Tables.PreferredWidth.Auto" />.</para>
- <seealso cref="P:Aspose.Words.Tables.CellFormat.Width" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Tables.CellFormat.VerticalMerge">
- <summary>
- Specifies how the cell is merged with other cells vertically.
- </summary>
- <remarks>
- <p>Cells can only be merged vertically if their left and right boundaries are identical.</p>
- <p>When cells are vertically merged, the display areas of the merged cells are consolidated.
- The consolidated area is used to display the contents of the first vertically merged cell
- and all other vertically merged cells must be empty.</p>
- <seealso cref="P:Aspose.Words.Tables.CellFormat.HorizontalMerge" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Tables.CellFormat.HorizontalMerge">
- <summary>
- Specifies how the cell is merged horizontally with other cells in the row.
- </summary>
- <seealso cref="P:Aspose.Words.Tables.CellFormat.VerticalMerge" />
- </member>
- <member name="P:Aspose.Words.Tables.CellFormat.Orientation">
- <summary>
- Returns or sets the orientation of text in a table cell.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.CellFormat.FitText">
- <summary>
- If true, fits text in the cell, compressing each paragraph to the width of the cell.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.CellFormat.WrapText">
- <summary>
- If true, wrap text for the cell.
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.CellMerge">
- <summary>
- Specifies how a cell in a table is merged with other cells.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.CellMerge.None">
- <summary>
- The cell is not merged.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.CellMerge.First">
- <summary>
- The cell is the first cell in a range of merged cells.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.CellMerge.Previous">
- <summary>
- The cell is merged to the previous cell horizontally or vertically.
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.CellCollection">
- <summary>
- Provides typed access to a collection of <see cref="T:Aspose.Words.Tables.Cell" /> nodes.
- </summary>
- </member>
- <member name="M:Aspose.Words.Tables.CellCollection.ToArray">
- <summary>
- Copies all cells from the collection to a new array of cells.
- </summary>
- <returns>An array of cells.</returns>
- </member>
- <member name="P:Aspose.Words.Tables.CellCollection.Item(System.Int32)">
- <summary>
- Retrieves a <b>Cell</b> at the given index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the collection.</param>
- </member>
- <member name="T:Aspose.Words.Tables.CellVerticalAlignment">
- <summary>
- Specifies vertical justification of text inside a table cell.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.CellVerticalAlignment.Top">
- <summary>
- Text is aligned at the top of a cell.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.CellVerticalAlignment.Center">
- <summary>
- Text is aligned in the middle of a cell.
- </summary>
- </member>
- <member name="F:Aspose.Words.Tables.CellVerticalAlignment.Bottom">
- <summary>
- Text is aligned at the bottom of the cell.
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.NamespaceDoc">
- <summary>
- <p>The <b>Aspose.Words.Tables</b> namespace contains classes that
- represent tables, rows, cells and their formatting.</p>
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.Row">
- <summary>
- Represents a table row.
- </summary>
- <remarks>
- <p>
- <b>Row</b> can only be a child of a <b>Table</b>.</p>
- <p>
- <b>Row</b> can contain one or more <b>Cell</b> nodes.</p>
- <p>A minimal valid row needs to have at least one <b>Cell</b>.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Tables.Row.#ctor(Aspose.Words.DocumentBase)">
- <summary>
- Initializes a new instance of the <b>Row</b> class.
- </summary>
- <remarks>
- <p>When <b>Row</b> is created, it belongs to the specified document, but is not
- yet part of the document and <b>ParentNode</b> is null.</p>
- <p>To append <b>Row</b> to the document use InsertAfter or InsertBefore
- on the table where you want the row inserted.</p>
- </remarks>
- <param name="doc">The owner document.</param>
- </member>
- <member name="M:Aspose.Words.Tables.Row.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls DocumentVisitor.VisitRowStart, then calls Accept for all child nodes of the section
- and calls DocumentVisitor.VisitRowEnd at the end.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Tables.Row.GetText">
- <summary>
- Gets the text of all cells in this row including the end of row character.
- </summary>
- <remarks>
- <p>Returns concatenated text of all child nodes with the end of row character
- <see cref="F:Aspose.Words.ControlChar.Cell">ControlChar.Cell</see> appended at the end.</p>
- <p>The returned string includes all control and special characters as described in <see cref="T:Aspose.Words.ControlChar" />.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Tables.Row.EnsureMinimum">
- <summary>
- If the <b>Row</b> has no cells, creates and appends one <b>Cell</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Row.NodeType">
- <summary>
- Returns <b>NodeType.Row</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Row.ParentTable">
- <summary>
- Returns the immediate parent table of the row.
- </summary>
- <remarks>Equivalent to <c>(Table)FirstNonMarkupParentNode</c>.</remarks>
- </member>
- <member name="P:Aspose.Words.Tables.Row.IsFirstRow">
- <summary>
- True if this is the first row in a table; false otherwise.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Row.IsLastRow">
- <summary>
- True if this is the last row in a table; false otherwise.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Row.FirstCell">
- <summary>
- Returns the first <b>Cell</b> in the row.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Row.LastCell">
- <summary>
- Returns the last <b>Cell</b> in the row.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Row.Cells">
- <summary>
- Provides typed access to the <b>Cell</b> child nodes of the row.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Row.RowFormat">
- <summary>
- Provides access to the formatting properties of the row.
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.RowFormat">
- <summary>
- Represents all formatting for a table row.
- </summary>
- <dev>
- RK I don't expose Shading here because default shading in MS Word works very strange,
- cells do not seem to inherit the shading specified for the table so it will be pretty
- confusing to work with. Setting row shading should actually go and set shading for
- all of the cells in the row.
- </dev>
- </member>
- <member name="M:Aspose.Words.Tables.RowFormat.ClearFormatting">
- <summary>
- Resets to default row formatting.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.RowFormat.Borders">
- <summary>
- Gets the collection of default cell borders for the row.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.RowFormat.Height">
- <summary>
- Gets or sets the height of the table row in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.RowFormat.HeightRule">
- <summary>
- Gets or sets the rule for determining the height of the table row.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.RowFormat.AllowBreakAcrossPages">
- <summary>
- True if the text in a table row is allowed to split across a page break.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.RowFormat.HeadingFormat">
- <summary>
- True if the row is repeated as a table heading on every page when the table spans more than one page.
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.RowCollection">
- <summary>
- Provides typed access to a collection of <see cref="T:Aspose.Words.Tables.Row" /> nodes.
- </summary>
- </member>
- <member name="M:Aspose.Words.Tables.RowCollection.ToArray">
- <summary>
- Copies all rows from the collection to a new array of rows.
- </summary>
- <returns>An array of rows.</returns>
- </member>
- <member name="P:Aspose.Words.Tables.RowCollection.Item(System.Int32)">
- <summary>
- Retrieves a <b>Row</b> at the given index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the collection.</param>
- </member>
- <member name="T:Aspose.Words.Tables.Table">
- <summary>
- Represents a table in a Word document.
- </summary>
- <remarks>
- <p>
- <b>Table</b> is a block-level node and can be a child of classes derived from <b>Story</b> or
- <b>InlineStory</b>.</p>
- <p>
- <b>Table</b> can contain one or more <b>Row</b> nodes.</p>
- <p>A minimal valid table needs to have at least one <b>Row</b>.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Tables.Table.#ctor(Aspose.Words.DocumentBase)">
- <summary>
- Initializes a new instance of the <b>Table</b> class.
- </summary>
- <remarks>
- <p>When <b>Table</b> is created, it belongs to the specified document, but is not
- yet part of the document and <b>ParentNode</b> is null.</p>
- <p>To append <b>Table</b> to the document use InsertAfter or InsertBefore
- on the story where you want the table inserted.</p>
- </remarks>
- <param name="doc">The owner document.</param>
- </member>
- <member name="M:Aspose.Words.Tables.Table.ConvertToHorizontallyMergedCells">
- <summary>
- Converts cells horizontally merged by width to cells merged by <see cref="P:Aspose.Words.Tables.CellFormat.HorizontalMerge" />.
- </summary>
- <remark>
- <p>Table cells can be horizontally merged either using merge flags <see cref="P:Aspose.Words.Tables.CellFormat.HorizontalMerge" /> or using cell width <see cref="P:Aspose.Words.Tables.CellFormat.Width" />.</p>
- <p>When table cell is merged by width property <see cref="P:Aspose.Words.Tables.CellFormat.HorizontalMerge" /> is meaningless but sometimes having merge flags is more convenient way.</p>
- <p>Use this method to transforms table cells horizontally merged by width to cells merged by merge flags.</p>
- </remark>
- </member>
- <member name="M:Aspose.Words.Tables.Table.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls DocumentVisitor.VisitTableStart, then calls Accept for all child nodes of the section
- and calls DocumentVisitor.VisitTableEnd at the end.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Tables.Table.EnsureMinimum">
- <summary>
- If the table has no rows, creates and appends one <b>Row</b>.
- </summary>
- </member>
- <member name="M:Aspose.Words.Tables.Table.SetBorders(Aspose.Words.LineStyle,System.Double,System.Drawing.Color)">
- <summary>
- Sets all table borders to the specified line style, width and color.
- </summary>
- <param name="lineStyle">The line style to apply.</param>
- <param name="lineWidth">The line width to set (in points).</param>
- <param name="color">The color to use for the border.</param>
- </member>
- <member name="M:Aspose.Words.Tables.Table.SetBorder(Aspose.Words.BorderType,Aspose.Words.LineStyle,System.Double,System.Drawing.Color,System.Boolean)">
- <summary>
- Sets the specified table border to the specified line style, width and color.
- </summary>
- <param name="borderType">The table border to change.</param>
- <param name="lineStyle">The line style to apply.</param>
- <param name="lineWidth">The line width to set (in points).</param>
- <param name="color">The color to use for the border.</param>
- <param name="isOverrideCellBorders">When <c>true</c>, causes all existing explicit cell borders to be removed.</param>
- </member>
- <member name="M:Aspose.Words.Tables.Table.ClearBorders">
- <summary>
- Removes all table and cell borders on this table.
- </summary>
- </member>
- <member name="M:Aspose.Words.Tables.Table.SetShading(Aspose.Words.TextureIndex,System.Drawing.Color,System.Drawing.Color)">
- <summary>
- Sets shading to the specified values on all cells in the table.
- </summary>
- <param name="texture">The texture to apply.</param>
- <param name="foregroundColor">The color of the texture.</param>
- <param name="backgroundColor">The color of the background fill.</param>
- </member>
- <member name="M:Aspose.Words.Tables.Table.ClearShading">
- <summary>
- Removes all shading on the table.
- </summary>
- </member>
- <member name="M:Aspose.Words.Tables.Table.AutoFit(Aspose.Words.Tables.AutoFitBehavior)">
- <summary>
- Resizes the table and cells according to the specified auto fit behavior.
- </summary>
- <remarks>
- <para>This method mimics the commands available in the Auto Fit menu for a table in Microsoft Word.
- The commands available are "Auto Fit to Contents", "Auto Fit to Window" and "Fixed Column Width". In Microsoft Word
- these commands set relevant table properties and then update the table layout and Aspose.Words does the same for you.</para>
- </remarks>
- <param name="behavior">Specifies how to auto fit the table.</param>
- </member>
- <member name="P:Aspose.Words.Tables.Table.NodeType">
- <summary>
- Returns <b>NodeType.Table</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.FirstRow">
- <summary>
- Returns the first <b>Row</b> node in the table.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.LastRow">
- <summary>
- Returns the last <b>Row</b> node in the table.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.Rows">
- <summary>
- Provides typed access to the rows of the table.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.Alignment">
- <summary>
- Specifies how an inline table is aligned in the document.
- </summary>
- <remarks>
- <para>The default value is <see cref="F:Aspose.Words.Tables.TableAlignment.Left" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Tables.Table.AllowAutoFit">
- <summary>
- Allows Microsoft Word and Aspose.Words to automatically resize cells in a table to fit their contents.
- </summary>
- <remarks>
- <para>The default value is <c>true</c>.</para>
- <seealso cref="M:Aspose.Words.Tables.Table.AutoFit(Aspose.Words.Tables.AutoFitBehavior)" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Tables.Table.PreferredWidth">
- <summary>
- Gets or sets the table preferred width.
- </summary>
- <remarks>
- <para>The default value is <see cref="F:Aspose.Words.Tables.PreferredWidth.Auto" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Tables.Table.Bidi">
- <summary>
- Gets or sets whether this is a right-to-left table.
- </summary>
- <remarks>
- <p>When <c>true</c>, the cells in this row are laid out right to left.</p>
- <para>The default value is <c>false</c>.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Tables.Table.LeftPadding">
- <summary>
- Gets or sets the amount of space (in points) to add to the left of the contents of cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.RightPadding">
- <summary>
- Gets or sets the amount of space (in points) to add to the right of the contents of cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.TopPadding">
- <summary>
- Gets or sets the amount of space (in points) to add above the contents of cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.BottomPadding">
- <summary>
- Gets or sets the amount of space (in points) to add below the contents of cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.CellSpacing">
- <summary>
- Gets or sets the amount of space (in points) between the cells.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.AllowCellSpacing">
- <summary>
- Gets or sets the "Allow spacing between cells" option.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.LeftIndent">
- <summary>
- Gets or sets the value that represents the left indent of the table.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.StyleOptions">
- <summary>
- Gets or sets bit flags that specify how a table style is applied to this table.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.Style">
- <summary>
- Gets or sets the table style applied to this table.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.StyleName">
- <summary>
- Gets or sets the name of the table style applied to this table.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.StyleIdentifier">
- <summary>
- Gets or sets the locale independent style identifier of the table style applied to this table.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.TextWrapping">
- <summary>
- Gets or sets <see cref="P:Aspose.Words.Tables.Table.TextWrapping" /> for table.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.Title">
- <summary>
- Gets or sets title of this table.
- It provides an alternative text representation of the information contained in the table.
- </summary>
- <remarks>
- <para>The default value is an empty string.</para>
- <para>This property is meaningful for ISO/IEC 29500 compliant DOCX documents
- (<see cref="T:Aspose.Words.Saving.OoxmlCompliance" />).
- When saved to pre-ISO/IEC 29500 formats, the property is ignored.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Tables.Table.Description">
- <summary>
- Gets or sets description of this table.
- It provides an alternative text representation of the information contained in the table.
- </summary>
- <remarks>
- <para>The default value is an empty string.</para>
- <para>This property is meaningful for ISO/IEC 29500 compliant DOCX documents
- (<see cref="T:Aspose.Words.Saving.OoxmlCompliance" />).
- When saved to pre-ISO/IEC 29500 formats, the property is ignored.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Tables.Table.DistanceLeft">
- <summary>
- Gets distance between table left and the surrounding text, in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.DistanceRight">
- <summary>
- Gets distance between table right and the surrounding text, in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.DistanceTop">
- <summary>
- Gets distance between table top and the surrounding text, in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.DistanceBottom">
- <summary>
- Gets distance between table bottom and the surrounding text, in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.RelativeHorizontalAlignment">
- <summary>
- Gets or sets floating table relative horizontal alignment.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.RelativeVerticalAlignment">
- <summary>
- Gets or sets floating table relative vertical alignment.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.HorizontalAnchor">
- <summary>
- Gets the base object from which the horizontal positioning of floating table should be calculated.
- Default value is <see cref="F:Aspose.Words.Drawing.RelativeHorizontalPosition.Column" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.VerticalAnchor">
- <summary>
- Gets the base object from which the vertical positioning of floating table should be calculated.
- Default value is <see cref="F:Aspose.Words.Drawing.RelativeVerticalPosition.Margin" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.AbsoluteHorizontalDistance">
- <summary>
- Gets or sets absolute horizontal floating table position specified by the table properties, in points.
- Default value is 0.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.AbsoluteVerticalDistance">
- <summary>
- Gets or sets absolute vertical floating table position specified by the table properties, in points.
- Default value is 0.
- </summary>
- </member>
- <member name="P:Aspose.Words.Tables.Table.AllowOverlap">
- <summary>
- Gets whether a floating table shall allow other floating objects in the document
- to overlap its extents when displayed.
- Default value is <c>true</c>.
- </summary>
- </member>
- <member name="T:Aspose.Words.Tables.TableCollection">
- <summary>
- Provides typed access to a collection of <see cref="T:Aspose.Words.Tables.Table" /> nodes.
- </summary>
- </member>
- <member name="M:Aspose.Words.Tables.TableCollection.ToArray">
- <summary>
- Copies all tables from the collection to a new array of tables.
- </summary>
- <returns>An array of tables.</returns>
- </member>
- <member name="P:Aspose.Words.Tables.TableCollection.Item(System.Int32)">
- <summary>
- Retrieves a <b>Table</b> at the given index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the collection.</param>
- </member>
- <member name="T:Aspose.Words.Saving.CompressionLevel">
- <summary>
- Compression level for OOXML files.
- <para>
- (DOCX and DOTX files are internally a ZIP-archive, this property controls the compression level of the archive.
- </para><para>
- Note, that FlatOpc file is not a ZIP-archive, therefore, this property does not affect the FlatOpc files.)
- </para></summary>
- </member>
- <member name="F:Aspose.Words.Saving.CompressionLevel.Normal">
- <summary>
- Normal compression level. Default compression level used by Aspose.Words.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.CompressionLevel.Maximum">
- <summary>
- Maximum compression level.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.CompressionLevel.Fast">
- <summary>
- Fast compression level.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.CompressionLevel.SuperFast">
- <summary>
- Super Fast compression level. Microsoft Word uses this compression level.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.Dml3DEffectsRenderingMode">
- <summary>
- Specifies how 3D shape effects are rendered.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.Dml3DEffectsRenderingMode.Basic">
- <summary>
- A lightweight and stable rendering, based on the internal engine,
- but advanced effects such as lighting, materials and other additional effects
- are not displayed when using this mode.
- Please see documentation for details.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.Dml3DEffectsRenderingMode.Advanced">
- <summary>
- Rendering of an extended list of special effects including advanced 3D effects
- such as bevels, lighting and materials.
- </summary>
- <remarks>
- The current implementation uses OpenGL.
- Please make sure that OpenGL library version 1.1 or higher is installed on your system before use.
- This mode is still under development, and some things may not be supported, so it's recommended to use
- the <see cref="F:Aspose.Words.Saving.Dml3DEffectsRenderingMode.Basic" /> mode if the rendering result is not acceptable.
- Please see documentation for details.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.HeaderFooterBookmarksExportMode">
- <summary>
- Specifies how bookmarks in headers/footers are exported.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HeaderFooterBookmarksExportMode.None">
- <summary>
- Bookmarks in headers/footers are not exported.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HeaderFooterBookmarksExportMode.First">
- <summary>
- Only bookmark in first header/footer of the section is exported.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HeaderFooterBookmarksExportMode.All">
- <summary>
- Bookmarks in all headers/footers are exported.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.ImageSaveOptions">
- <summary>
- Allows to specify additional options when rendering document pages or shapes to images.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.ImageSaveOptions.#ctor(Aspose.Words.SaveFormat)">
- <summary>
- Initializes a new instance of this class that can be used to save rendered images in the
- <see cref="F:Aspose.Words.SaveFormat.Tiff" />, <see cref="F:Aspose.Words.SaveFormat.Png" />, <see cref="F:Aspose.Words.SaveFormat.Bmp" />,
- <see cref="F:Aspose.Words.SaveFormat.Emf" />, <see cref="F:Aspose.Words.SaveFormat.Jpeg" /> or <see cref="F:Aspose.Words.SaveFormat.Svg" /> format.
- <see cref="F:Aspose.Words.SaveFormat.Png" />, <see cref="F:Aspose.Words.SaveFormat.Bmp" />, <see cref="F:Aspose.Words.SaveFormat.Jpeg" />
- or <see cref="F:Aspose.Words.SaveFormat.Svg" /> format.
- </summary>
- <param name="saveFormat">Can be
- <see cref="F:Aspose.Words.SaveFormat.Tiff" />, <see cref="F:Aspose.Words.SaveFormat.Png" />, <see cref="F:Aspose.Words.SaveFormat.Bmp" />,
- <see cref="F:Aspose.Words.SaveFormat.Emf" />, <see cref="F:Aspose.Words.SaveFormat.Jpeg" /> or <see cref="F:Aspose.Words.SaveFormat.Svg" />.
- <see cref="F:Aspose.Words.SaveFormat.Png" />, <see cref="F:Aspose.Words.SaveFormat.Bmp" />, <see cref="F:Aspose.Words.SaveFormat.Jpeg" />
- or <see cref="F:Aspose.Words.SaveFormat.Svg" />.
- </param>
- </member>
- <member name="M:Aspose.Words.Saving.ImageSaveOptions.Clone">
- <summary>
- Creates a deep clone of this object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the rendered document pages or shapes will be saved if this save options object is used.
- Can be a raster
- <see cref="F:Aspose.Words.SaveFormat.Tiff" />, <see cref="F:Aspose.Words.SaveFormat.Png" />, <see cref="F:Aspose.Words.SaveFormat.Bmp" />,
- <see cref="F:Aspose.Words.SaveFormat.Jpeg" /> or vector <see cref="F:Aspose.Words.SaveFormat.Emf" />, <see cref="F:Aspose.Words.SaveFormat.Svg" />.
- </summary>
- <remarks>
- <para>On different platforms, the supported formats may be different. The number of other options depends on the selected format.</para>
- <para>Also, it is possible to save to SVG both via ImageSaveOptions and via <see cref="T:Aspose.Words.Saving.SvgSaveOptions" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.PageSet">
- <summary>
- Gets or sets the pages to render.
- Default is all the pages in the document.
- </summary>
- <remarks>
- <para>This property has effect only when rendering document pages. This property is ignored when rendering shapes to images.</para>
- <para>Overrides<see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageIndex" /> and<see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageCount" /> when set.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.PageIndex">
- <summary>
- Gets or sets the 0-based index of the first page to render.
- Default is 0.
- </summary>
- <remarks>
- <para>This property has effect only when rendering document pages. This property is ignored when rendering shapes to images.</para>
- <para>Overrides<see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageSet" /> when set.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.PageCount">
- <summary>
- Gets or sets the number of pages to render when saving to a multipage TIFF
- or SVG file (for other formats only the first page of the range is saved).
- <para>Default is <see cref="F:System.Int32.MaxValue" /> which means all pages of the document will be rendered.</para></summary>
- <remarks>
- <para>This property has effect only when rendering document pages. This property is ignored when rendering shapes to images.</para>
- <para>Overrides<see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageSet" /> when set.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.PaperColor">
- <summary>
- Gets or sets the background (paper) color for the generated images.
- <p>The default value is <see cref="P:System.Drawing.Color.White" />.</p></summary>
- <remarks>
- <para>When rendering pages of a document that specifies its own background color,
- then the document background color will override the color specified by this property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.PixelFormat">
- <summary>
- Gets or sets the pixel format for the generated images.
- </summary>
- <remarks>
- <para>This property has effect only when saving to raster image formats.</para>
- <p>The default value is <see cref="F:Aspose.Words.Saving.ImagePixelFormat.Format32BppArgb" />.</p>
- <p>Pixel format of the output image may differ from the set value
- because of work of GDI+.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.HorizontalResolution">
- <summary>
- Gets or sets the horizontal resolution for the generated images, in dots per inch.
- </summary>
- <remarks>
- <para>This property has effect only when saving to raster image formats and affects the output size in pixels.</para>
- <p>The default value is 96.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.VerticalResolution">
- <summary>
- Gets or sets the vertical resolution for the generated images, in dots per inch.
- </summary>
- <remarks>
- <para>This property has effect only when saving to raster image formats and affects the output size in pixels.</para>
- <p>The default value is 96.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.Resolution">
- <summary>
- Sets both horizontal and vertical resolution for the generated images, in dots per inch.
- </summary>
- <remarks>
- <para>This property has effect only when saving to raster image formats.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.JpegQuality">
- <summary>
- Gets or sets a value determining the quality of the generated JPEG images.
- </summary>
- <remarks>
- <para>Has effect only when saving to JPEG.</para>
- <p>Use this property to get or set the quality of generated images when saving in JPEG format.
- The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100
- means best quality but minimum compression.</p>
- <p>The default value is 95.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.TiffCompression">
- <summary>
- Gets or sets the type of compression to apply when saving generated images to the TIFF format.
- </summary>
- <remarks>
- <para>Has effect only when saving to TIFF.</para>
- <p>The default value is <see cref="F:Aspose.Words.Saving.TiffCompression.Lzw" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.ImageColorMode">
- <summary>
- Gets or sets the color mode for the generated images.
- </summary>
- <remarks>
- <para>This property has effect only when saving to raster image formats.</para>
- <para>The default value is <see cref="F:Aspose.Words.Saving.ImageColorMode.None" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.ImageBrightness">
- <summary>
- Gets or sets the brightness for the generated images.
- </summary>
- <remarks>
- <para>This property has effect only when saving to raster image formats.</para>
- <para>The default value is 0.5. The value must be in the range between 0 and 1.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.ImageContrast">
- <summary>
- Gets or sets the contrast for the generated images.
- </summary>
- <remarks>
- <para>This property has effect only when saving to raster image formats.</para>
- <para>The default value is 0.5. The value must be in the range between 0 and 1.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.Scale">
- <summary>
- Gets or sets the zoom factor for the generated images.
- </summary>
- <remarks>
- The default value is 1.0. The value must be greater than 0.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.MetafileRenderingOptions">
- <summary>
- Allows to specify how metafiles are treated in the rendered output.
- </summary>
- <remarks>
- <para>When <see cref="F:Aspose.Words.Saving.MetafileRenderingMode.Vector" /> is specified, Aspose.Words renders
- metafile to vector graphics using its own metafile rendering engine first and then renders vector
- graphics to the image.</para>
- <para>When <see cref="F:Aspose.Words.Saving.MetafileRenderingMode.Bitmap" /> is specified, Aspose.Words renders
- metafile directly to the image using the GDI+ metafile rendering engine.</para>
- <para>GDI+ metafile rendering engine works faster, supports almost all metafile features but on low
- resolutions may produce inconsistent result when compared to the rest of vector graphics (especially for text)
- on the page. Aspose.Words metafile rendering engine will produce more consistent result even
- on low resolutions but works slower and may inaccurately render complex metafiles.</para>
- <para>The default value for <see cref="T:Aspose.Words.Saving.MetafileRenderingMode" /> is <see cref="F:Aspose.Words.Saving.MetafileRenderingMode.Bitmap" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.TiffBinarizationMethod">
- <summary>
- Gets or sets method used while converting images to 1 bpp format
- when <see cref="P:Aspose.Words.Saving.ImageSaveOptions.SaveFormat" /> is SaveFormat.Tiff and
- <see cref="P:Aspose.Words.Saving.ImageSaveOptions.TiffCompression" /> is equal to TiffCompression.Ccitt3 or TiffCompression.Ccitt4.
- </summary>
- <remarks>
- <para>The default value is ImageBinarizationMethod.Threshold.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.ThresholdForFloydSteinbergDithering">
- <summary>
- Gets or sets the threshold that determines the value
- of the binarization error in the Floyd-Steinberg method.
- when <see cref="T:Aspose.Words.Saving.ImageBinarizationMethod" /> is ImageBinarizationMethod.FloydSteinbergDithering.
- </summary>
- <remarks>
- <para>The default value is 128.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.GraphicsQualityOptions">
- <summary>
- Allows to specify rendering mode and quality for the <see cref="T:System.Drawing.Graphics" /> object.
- </summary>
- <remarks>
- <para>Use this property to override the Graphics settings provided by Aspose.Words engine by default.</para>
- <para>It will take effect only when a document is being saved to an image-like format.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSaveOptions.UseGdiEmfRenderer">
- <summary>
- Gets or sets a value determining whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF.
- </summary>
- <remarks>
- <para>If set to <c>true</c> GDI+ metafile renderer is used. I.e. content is written to GDI+ graphics
- object and saved to metafile.</para>
- <para>If set to <c>false</c> Aspose.Words metafile renderer is used. I.e. content is written directly
- to the metafile format with Aspose.Words.</para>
- <para>Has effect only when saving to EMF.</para>
- <para>GDI+ saving works only on .NET.</para>
- <para>The default value is <c>true</c>.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.PageSet">
- <summary>
- Describes a random set of pages.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.PageSet.#ctor(System.Int32[])">
- <summary>
- Creates a page set based on exact page indices.
- </summary>
- <param name="pages">Zero-based indices of pages.</param>
- <remarks>
- If a page is encountered that is not in the document, an exception will be thrown during rendering.
- <see cref="F:System.Int32.MaxValue" /> means the last page in the document.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Saving.PageSet.#ctor(Aspose.Words.Saving.PageRange[])">
- <summary>
- Creates a page set based on ranges.
- </summary>
- <param name="ranges">Array of page ranges.</param>
- <remarks>
- If a range is encountered that starts after the last page in the document,
- an exception will be thrown during rendering.
- All ranges that end after the last page are truncated to fit in the document.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Saving.PageSet.#ctor(System.String)">
- <summary>
- Creates a page set based on the page numbers and page ranges, separated by commas.
- For example, "3, 5-8" includes page 3 and pages 5 through 8.
- </summary>
- <param name="pages">String description of pages and page ranges</param>
- <remarks>
- If a range or a page is encountered that starts after the last page in the document,
- an exception will be thrown during rendering.
- All ranges that end after the last page are truncated to fit in the document.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Saving.PageSet.#ctor(Aspose.Words.Saving.PageParity,Aspose.Words.Saving.PageRange[])">
- <summary>
- Creates a page set based on ranges.
- </summary>
- <param name="parity">Parity of pages to select.</param>
- <param name="ranges">Array of page ranges</param>
- <remarks>
- Even pages have odd indices and vice versa, since page indices are zero-based.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PageSet.All">
- <summary>
- Gets a set with all the pages of the document in their original order.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.PageSet.Even">
- <summary>
- Gets a set with all the even pages of the document in their original order.
- </summary>
- <remarks>
- Even pages have odd indices since page indices are zero-based.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PageSet.Odd">
- <summary>
- Gets a set with all the odd pages of the document in their original order.
- </summary>
- <remarks>
- Odd pages have even indices since page indices are zero-based.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.TableContentAlignment">
- <summary>
- Allows to specify the alignment of the content of the table to be used when exporting into Markdown format.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.TableContentAlignment.Auto">
- <summary>
- The alignment will be taken from the first paragraph in corresponding table column.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.TableContentAlignment.Left">
- <summary>
- The content of tables will be aligned to the Left.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.TableContentAlignment.Center">
- <summary>
- The content of tables will be aligned to the Center.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.TableContentAlignment.Right">
- <summary>
- The content of tables will be aligned to the Right.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.TxtListIndentation">
- <summary>
- Specifies how list levels are indented when document is exporting to <see cref="F:Aspose.Words.SaveFormat.Text" /> format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.TxtListIndentation.Count">
- <summary>
- Gets or sets how many <see cref="P:Aspose.Words.Saving.TxtListIndentation.Character" /> to use as indentation per one list level.
- The default value is 0, that means no indentation.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.TxtListIndentation.Character">
- <summary>
- Gets or sets which character to use for indenting list levels.
- The default value is '\0', that means there is no indentation.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.TxtExportHeadersFootersMode">
- <summary>
- Specifies the way headers and footers are exported to plain text format.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.TxtExportHeadersFootersMode.None">
- <summary>
- No headers and footers are exported.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.TxtExportHeadersFootersMode.PrimaryOnly">
- <summary>
- Only primary headers and footers are exported at the beginning and end of each section.
- </summary>
- <remarks>
- <para>It is hard to meaningfully output headers and footers to plain text because it is not paginated.</para>
- <para>When this mode is used, only primary headers and footers are exported at the beginning and end of each section.</para>
- </remarks>
- </member>
- <member name="F:Aspose.Words.Saving.TxtExportHeadersFootersMode.AllAtEnd">
- <summary>
- All headers and footers are placed after all section bodies at the very end of a document.
- </summary>
- <remarks>
- This mode is similar to Word.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.MarkdownSaveOptions">
- <summary>
- Class to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.Markdown" /> format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.MarkdownSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can only be <see cref="F:Aspose.Words.SaveFormat.Markdown" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.MarkdownSaveOptions.TableContentAlignment">
- <summary>
- Gets or sets a value that specifies how to align contents in tables
- when exporting into the <see cref="F:Aspose.Words.SaveFormat.Markdown" /> format.
- The default value is <see cref="F:Aspose.Words.Saving.TableContentAlignment.Auto" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.MarkdownSaveOptions.ImagesFolder">
- <summary>
- Specifies the physical folder where images are saved when exporting a document to
- the <see cref="F:Aspose.Words.SaveFormat.Markdown" /> format. Default is an empty string.
- </summary>
- <remarks>
- <para>
- When you save a <see cref="T:Aspose.Words.Document" /> in <see cref="F:Aspose.Words.SaveFormat.Markdown" /> format,
- Aspose.Words needs to save all images embedded in the document as standalone files.
- <see cref="P:Aspose.Words.Saving.MarkdownSaveOptions.ImagesFolder" /> allows you to specify where the images will be saved.
- </para>
- <para>
- If you save a document into a file and provide a file name, Aspose.Words, by default, saves the images in
- the same folder where the document file is saved. Use <see cref="P:Aspose.Words.Saving.MarkdownSaveOptions.ImagesFolder" /> to override this behavior.
- </para>
- <para>
- If you save a document into a stream, Aspose.Words does not have a folder
- where to save the images, but still needs to save the images somewhere. In this case,
- you need to specify an accessible folder in the <see cref="P:Aspose.Words.Saving.MarkdownSaveOptions.ImagesFolder" /> property.
- </para>
- <para>
- If the folder specified by <see cref="P:Aspose.Words.Saving.MarkdownSaveOptions.ImagesFolder" /> doesn't exist, it will be created automatically.
- </para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.TxtSaveOptionsBase">
- <summary>
- The base class for specifying additional options when saving a document into a text based formats.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.TxtSaveOptionsBase.Encoding">
- <summary>
- Specifies the encoding to use when exporting in text formats.
- Default value is <b>Encoding.UTF8</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.TxtSaveOptionsBase.ParagraphBreak">
- <summary>
- Specifies the string to use as a paragraph break when exporting in text formats.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.ControlChar.CrLf" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.TxtSaveOptionsBase.ForcePageBreaks">
- <summary>
- <para>Allows to specify whether the page breaks should be preserved during export.</para>
- <para>The default value is <b>false</b>.</para>
- </summary>
- <remarks>
- The property affects only page breaks that are inserted explicitly into a document.
- It is not related to page breaks that MS Word automatically inserts at the end of each page.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.TxtSaveOptionsBase.ExportHeadersFootersMode">
- <summary>
- Specifies the way headers and footers are exported to the text formats.
- Default value is <see cref="F:Aspose.Words.Saving.TxtExportHeadersFootersMode.PrimaryOnly" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.HtmlMetafileFormat">
- <summary>
- Indicates the format in which metafiles are saved to HTML documents.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HtmlMetafileFormat.Png">
- <summary>
- Metafiles are rendered to raster PNG images.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HtmlMetafileFormat.Svg">
- <summary>
- Metafiles are converted to vector SVG images.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HtmlMetafileFormat.EmfOrWmf">
- <summary>
- Metafiles are saved as is, without conversion.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.OdtSaveMeasureUnit">
- <summary>
- Specified units of measure to apply to measurable document content such as shape, widths and other during saving.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.OdtSaveMeasureUnit.Centimeters">
- <summary>
- Specifies that the document content is saved using centimeters.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.OdtSaveMeasureUnit.Inches">
- <summary>
- Specifies that the document content is saved using inches.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.FixedPageSaveOptions">
- <summary>
- Contains common options that can be specified when saving a document into fixed page formats (PDF, XPS,
- images etc).
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.FixedPageSaveOptions.Equals(System.Object)">
- <summary>
- Determines whether the specified object is equal in value to the current object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.FixedPageSaveOptions.PageSet">
- <summary>
- Gets or sets the pages to render.
- Default is all the pages in the document.
- </summary>
- <remarks>
- Overrides <see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageIndex" /> and <see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageCount" /> when set.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.FixedPageSaveOptions.PageIndex">
- <summary>
- Gets or sets the 0-based index of the first page to save.
- Default is 0.
- </summary>
- <remarks>
- Overrides <see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageSet" /> when set.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.FixedPageSaveOptions.PageCount">
- <summary>
- Gets or sets the number of pages to save.
- Default is <see cref="F:System.Int32.MaxValue" /> which means all pages of the document will be rendered.
- </summary>
- <remarks>
- Overrides <see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageSet" /> when set.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.FixedPageSaveOptions.PageSavingCallback">
- <summary>
- Allows to control how separate pages are saved when a document is exported to fixed page format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.FixedPageSaveOptions.NumeralFormat">
- <summary>
- Gets or sets <see cref="T:Aspose.Words.Saving.NumeralFormat" /> used for rendering of numerals.
- European numerals are used by default.
- </summary>
- <remarks>
- If the value of this property is changed and page layout is already built then
- <see cref="M:Aspose.Words.Document.UpdatePageLayout" /> is invoked automatically to update any changes.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.FixedPageSaveOptions.MetafileRenderingOptions">
- <summary>
- Allows to specify metafile rendering options.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.FixedPageSaveOptions.JpegQuality">
- <summary>
- Gets or sets a value determining the quality of the JPEG images inside Html document.
- </summary>
- <remarks>
- <para>Has effect only when a document contains JPEG images.</para>
- <p>Use this property to get or set the quality of the images inside a document when saving in fixed page format.
- The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100
- means best quality but minimum compression.</p>
- <p>The default value is 95.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.FixedPageSaveOptions.ColorMode">
- <summary>
- Gets or sets a value determining how colors are rendered.
- </summary>
- <remarks>The default value is <see cref="F:Aspose.Words.Saving.ColorMode.Normal" />.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.FixedPageSaveOptions.OptimizeOutput">
- <summary>
- Flag indicates whether it is required to optimize output.
- 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.
-
- Default is false.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.HtmlVersion">
- <summary>
- Indicates the version of HTML is used when saving the document to <see cref="F:Aspose.Words.SaveFormat.Html" /> and
- <see cref="F:Aspose.Words.SaveFormat.Mhtml" /> formats.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HtmlVersion.Xhtml">
- <summary>
- Saves the document in compliance with the XHTML 1.0 Transitional standard.
- </summary>
- <remarks>
- <p>Aspose.Words aims to output XHTML according to the XHTML 1.0 Transitional standard,
- but the output will not always validate against the DTD. Some structures inside a Microsoft Word
- document are hard or impossible to map to a document that will validate against the XHTML schema.
- For example, XHTML does not allow nested lists (UL cannot be nested inside another UL element),
- but in Microsoft Word document multilevel lists occur quite often.</p>
- </remarks>
- </member>
- <member name="F:Aspose.Words.Saving.HtmlVersion.Html5">
- <summary>
- Saves the document in compliance with the HTML 5 standard.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.GraphicsQualityOptions">
- <summary>
- Allows to specify additional <see cref="T:System.Drawing.Graphics" /> quality options.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.GraphicsQualityOptions.StringFormat">
- <summary>
- Gets or sets text layout information (such as alignment, orientation and tab stops) display manipulations
- (such as ellipsis insertion and national digit substitution) and OpenType features.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.GraphicsQualityOptions.CompositingMode">
- <summary>
- Gets or sets a value that specifies how composited images are drawn to this Graphics.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.GraphicsQualityOptions.CompositingQuality">
- <summary>
- Gets or sets the rendering quality of composited images drawn to this Graphics.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.GraphicsQualityOptions.InterpolationMode">
- <summary>
- Gets or sets the interpolation mode associated with this Graphics.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.GraphicsQualityOptions.SmoothingMode">
- <summary>
- Gets or sets the rendering quality for this Graphics.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.GraphicsQualityOptions.TextRenderingHint">
- <summary>
- Gets or sets the rendering mode for text associated with this Graphics.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.HtmlOfficeMathOutputMode">
- <summary>
- Specifies how Aspose.Words exports OfficeMath to HTML, MHTML and EPUB.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HtmlOfficeMathOutputMode.Image">
- <summary>
- OfficeMath is converted to HTML as image specified by <img> tag.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HtmlOfficeMathOutputMode.MathML">
- <summary>
- OfficeMath is converted to HTML using MathML.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HtmlOfficeMathOutputMode.Text">
- <summary>
- OfficeMath is converted to HTML as sequence of runs specified by <span> tags.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.IPageSavingCallback">
- <summary>
- Implement this interface if you want to control how Aspose.Words saves separate pages when
- saving a document to fixed page formats.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.IPageSavingCallback.PageSaving(Aspose.Words.Saving.PageSavingArgs)">
- <summary>
- Called when Aspose.Words saves a separate page to fixed page formats.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.PageSavingArgs">
- <summary>
- Provides data for the <see cref="M:Aspose.Words.Saving.IPageSavingCallback.PageSaving(Aspose.Words.Saving.PageSavingArgs)" /> event.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.PageSavingArgs.PageStream">
- <summary>
- Allows to specify the stream where the document page will be saved to.
- </summary>
- <remarks>
- <para>This property allows you to save document pages to streams instead of files.</para>
- <para>The default value is <c>null</c>. When this property is <c>null</c>, the document page
- will be saved to a file specified in the <see cref="P:Aspose.Words.Saving.PageSavingArgs.PageFileName" /> property.</para>
- <para>If both PageStream and PageFileName are set, then PageStream will be used.</para>
- <seealso cref="P:Aspose.Words.Saving.PageSavingArgs.PageFileName" />
- <seealso cref="P:Aspose.Words.Saving.PageSavingArgs.KeepPageStreamOpen" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PageSavingArgs.KeepPageStreamOpen">
- <summary>
- Specifies whether Aspose.Words should keep the stream open or close it after saving a document page.
- </summary>
- <remarks>
- <para>Default is <c>false</c> and Aspose.Words will close the stream you provided
- in the <see cref="P:Aspose.Words.Saving.PageSavingArgs.PageStream" /> property after writing a document page into it.
- Specify <c>true</c> to keep the stream open.</para>
- <seealso cref="P:Aspose.Words.Saving.PageSavingArgs.PageStream" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PageSavingArgs.PageFileName">
- <summary>
- Gets or sets the file name where the document page will be saved to.
- </summary>
- <remarks>
- If not specified then page file name and path will be generated automatically using original file name.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PageSavingArgs.PageIndex">
- <summary>
- Current page index.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.ColorMode">
- <summary>
- Specifies how colors are rendered.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ColorMode.Normal">
- <summary>
- Rendering with unmodified colors.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ColorMode.Grayscale">
- <summary>
- Rendering with colors in a range of gray shades from white to black.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.HtmlFixedPageHorizontalAlignment">
- <summary>
- Specifies the horizontal alignment for pages in output HTML document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HtmlFixedPageHorizontalAlignment.Left">
- <summary>
- Align pages to the left.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HtmlFixedPageHorizontalAlignment.Center">
- <summary>
- Center pages. This is the default value.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HtmlFixedPageHorizontalAlignment.Right">
- <summary>
- Align pages to the right.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.PclSaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.Pcl" /> format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.PclSaveOptions.AddPrinterFont(System.String,System.String)">
- <summary>
- Adds information about font that is uploaded to the printer by manufacturer.
- </summary>
- <param name="fontFullName">Full name of the font (e.g. "Times New Roman Bold Italic").</param>
- <param name="fontPclName">Name of the font that is used in Pcl document.</param>
- <remarks>
- There are 52 fonts that are to be built in any printer according to Pcl specification.
- However manufactures can add some other fonts to their devices.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PclSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can only be <see cref="F:Aspose.Words.SaveFormat.Pcl" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.PclSaveOptions.RasterizeTransformedElements">
- <summary>
- Gets or sets a value determining whether or not complex transformed elements
- should be rasterized before saving to PCL document.
- Default is <c>true</c>.
- </summary>
- <remarks>
- PCL doesn't support some kind of transformations that are used by Aspose Words.
- E.g. rotated, skewed images and texture brushes. To properly render such elements
- rasterization process is used, i.e. saving to image and clipping.
- This process can take additional time and memory.
- If flag is set to <c>false</c>, some content in output may be different
- as compared with the source document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PclSaveOptions.FallbackFontName">
- <summary>
- Name of the font that will be used
- if no expected font is found in printer and built-in fonts collections.
- </summary>
- <remarks>
- If no fallback is found, a warning is generated and "Arial" font is used.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.PdfDigitalSignatureTimestampSettings">
- <summary>
- Contains settings of the digital signature timestamp.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.PdfDigitalSignatureTimestampSettings.#ctor">
- <summary>
- Initializes an instance of this class.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.PdfDigitalSignatureTimestampSettings.#ctor(System.String,System.String,System.String)">
- <summary>
- Initializes an instance of this class.
- </summary>
- <param name="serverUrl">Timestamp server URL.</param>
- <param name="userName">Timestamp server user name.</param>
- <param name="password">Timestamp server password.</param>
- </member>
- <member name="M:Aspose.Words.Saving.PdfDigitalSignatureTimestampSettings.#ctor(System.String,System.String,System.String,System.TimeSpan)">
- <summary>
- Initializes an instance of this class.
- </summary>
- <param name="serverUrl">Timestamp server URL.</param>
- <param name="userName">Timestamp server user name.</param>
- <param name="password">Timestamp server password.</param>
- <param name="timeout">Time-out value for accessing timestamp server.</param>
- </member>
- <member name="P:Aspose.Words.Saving.PdfDigitalSignatureTimestampSettings.ServerUrl">
- <summary>
- Timestamp server URL.
- </summary>
- <remarks>
- The default value is null.
- If null, then the digital signature will not be time-stamped.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfDigitalSignatureTimestampSettings.UserName">
- <summary>
- Timestamp server user name.
- </summary>
- <remarks>
- The default value is null.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfDigitalSignatureTimestampSettings.Password">
- <summary>
- Timestamp server password.
- </summary>
- <remarks>
- The default value is null.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfDigitalSignatureTimestampSettings.Timeout">
- <summary>
- Time-out value for accessing timestamp server.
- </summary>
- <remarks>
- The default value is 100 seconds.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.PdfImageColorSpaceExportMode">
- <summary>
- Specifies how the color space will be selected for the images in PDF document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfImageColorSpaceExportMode.Auto">
- <summary>
- Aspose.Words automatically selects the most appropriate color space for each image.
- </summary>
- <remarks>
- <para>Most of the images are saved in RGB color space. Also Indexed and Grayscale color spaces may be used. CMYK color space is never used.</para>
- <para>For some images the color space may be different on different platforms.</para>
- </remarks>
- </member>
- <member name="F:Aspose.Words.Saving.PdfImageColorSpaceExportMode.SimpleCmyk">
- <summary>
- Aspose.Words coverts RGB images to CMYK color space using simple formula.
- </summary>
- <remarks>
- <para>
- Images in RGB color space are converted to CMYK using formula:
- Black = minimum(1-Red,1-Green,1-Blue).
- Cyan = (1-Red-Black)/(1-Black).
- Magenta = (1-Green-Black)/(1-Black).
- Yellow = (1-Blue-Black)/(1-Black).
- RGB values are normalized - they are between 0 and 1.0.
- </para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.PdfCustomPropertiesExport">
- <summary>
- Specifies the way <see cref="P:Aspose.Words.Document.CustomDocumentProperties" /> are exported to PDF file.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfCustomPropertiesExport.None">
- <summary>
- No custom properties are exported.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfCustomPropertiesExport.Standard">
- <summary>
- Custom properties are exported as entries in /Info dictionary.
- <remarks></remarks><para>Custom properties with the following names are not exported:
- "Title", "Author", "Subject", "Keywords", "Creator", "Producer", "CreationDate", "ModDate", "Trapped".
- </para></summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfCustomPropertiesExport.Metadata">
- <summary>
- Custom properties are Metadata.
- </summary>
- <remarks>
- <para>The namespace of exported properties in XMP packet is "custprops".
- Every property has an associated xml-element "custprops:Property1", "custprops:Property2" and so on.
- There is "rdf:Description" element inside property element.
- The description element has two elements "custprops:Name", containing custom property's name
- as a value of this xml-element, and "custprops:Value", containing custom property's value as value of this xml-element.
- </para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.DmlEffectsRenderingMode">
- <summary>
- Specifies how DrawingML effects are rendered to fixed page formats.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.DmlEffectsRenderingMode.Simplified">
- <summary>
- Rendering of DrawingML effects are simplified.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.DmlEffectsRenderingMode.None">
- <summary>
- No DrawingML effects are rendered.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.DmlEffectsRenderingMode.Fine">
- <summary>
- DrawingML effects are rendered in fine mode which involves advanced processing.
- In this mode rendering of effects gives better results but at a higher performance cost than <see cref="F:Aspose.Words.Saving.DmlEffectsRenderingMode.Simplified" /> mode.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.DmlRenderingMode">
- <summary>
- Specifies how DrawingML shapes are rendered to fixed page formats.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.DmlRenderingMode.Fallback">
- <summary>
- If fall-back shape is available for DrawingML, Aspose.Words renders fall-back shape instead of the DrawingML.
- </summary>
- <remarks>
- Please note that after saving a document to a fixed page format with fall-back DML rendering mode,
- DML shapes in the AW document model are permanently replaced with their fall-back counterparts.
- As a result, saving the same document again will always use fall-back shapes, even if DmlRenderingMode is set to DrawingML.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Saving.DmlRenderingMode.DrawingML">
- <summary>
- Aspose.Words ignores fall-back shape of DrawingML and renders DrawingML itself.
- This is the default mode.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.DownsampleOptions">
- <summary>
- Allows to specify downsample options.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.DownsampleOptions.DownsampleImages">
- <summary>
- Specifies whether images should be downsampled.
- </summary>
- <remarks>
- The default value is <c>true</c>.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.DownsampleOptions.Resolution">
- <summary>
- Specifies the resolution in pixels per inch which the images should be downsampled to.
- </summary>
- <remarks>
- The default value is 220 ppi.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.DownsampleOptions.ResolutionThreshold">
- <summary>
- Specifies the threshold resolution in pixels per inch.
- If resolution of an image in the document is less than threshold value,
- the downsampling algorithm will not be applied.
- A value of 0 means the threshold check is not used and all images that can be reduced in size are downsampled.
- </summary>
- <remarks>
- The default value is 0.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.ImageBinarizationMethod">
- <summary>
- Specifies the method used to binarize image.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImageBinarizationMethod.Threshold">
- <summary>
- Specifies threshold method.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImageBinarizationMethod.FloydSteinbergDithering">
- <summary>
- Specifies dithering using Floyd-Steinberg error diffusion method.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.ExportFontFormat">
- <summary>
- Indicates the format that is used to export fonts while rendering to HTML fixed format.
- </summary>
- <seealso cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.FontFormat" />
- </member>
- <member name="F:Aspose.Words.Saving.ExportFontFormat.Woff">
- <summary>
- WOFF (Web Open Font Format).
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ExportFontFormat.Ttf">
- <summary>
- TTF (TrueType Font format).
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.PdfFontEmbeddingMode">
- <summary>
- Specifies how Aspose.Words should embed fonts.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfFontEmbeddingMode.EmbedAll">
- <summary>
- Aspose.Words embeds all fonts.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfFontEmbeddingMode.EmbedNonstandard">
- <summary>
- Aspose.Words embeds all fonts excepting standard Windows fonts Arial and Times New Roman.
- Only Arial and Times New Roman fonts are affected in this mode because MS Word doesn't embed
- only these fonts when saving document to PDF.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfFontEmbeddingMode.EmbedNone">
- <summary>
- Aspose.Words do not embed any fonts.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.PsSaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.Ps" /> format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.PsSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can only be <see cref="F:Aspose.Words.SaveFormat.Ps" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.PsSaveOptions.UseBookFoldPrintingSettings">
- <summary>
- Gets or sets a boolean value indicating whether the document should be saved using a booklet printing layout,
- if it is specified via <see cref="P:Aspose.Words.PageSetup.MultiplePages" />.
- </summary>
- <remarks>
- <para>
- If this option is specified, <see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageSet" />, <see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageIndex" />
- and <see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageCount" /> are ignored when saving.
- This behavior matches MS Word.
- If book fold printing settings are not specified in page setup, this option will have no effect.
- </para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.ResourceSavingArgs">
- <summary>
- Provides data for the <see cref="M:Aspose.Words.Saving.IResourceSavingCallback.ResourceSaving(Aspose.Words.Saving.ResourceSavingArgs)" /> event.
- </summary>
- <remarks>
- <para>By default, when Aspose.Words saves a document to fixed page HTML or SVG, it saves each resource into
- a separate file. Aspose.Words uses the document file name and a unique number to generate unique file name
- for each resource found in the document.</para>
- <para>
- <see cref="T:Aspose.Words.Saving.ResourceSavingArgs" /> allows to redefine how resource file names are generated or to
- completely circumvent saving of resources into files by providing your own stream objects.</para>
- <para>To apply your own logic for generating resource file names use the
- <see cref="P:Aspose.Words.Saving.ResourceSavingArgs.ResourceFileName" /> property.</para>
- <para>To save resources into streams instead of files, use the <see cref="P:Aspose.Words.Saving.ResourceSavingArgs.ResourceStream" /> property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ResourceSavingArgs.Document">
- <summary>
- Gets the document object that is currently being saved.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.ResourceSavingArgs.ResourceFileName">
- <summary>
- Gets or sets the file name (without path) where the resource will be saved to.
- </summary>
- <remarks>
- <para>This property allows you to redefine how the resource file names are generated
- during export to fixed page HTML or SVG.</para>
- <para>When the event is fired, this property contains the file name that was generated
- by Aspose.Words. You can change the value of this property to save the resource into a
- different file. Note that file names must be unique.</para>
- <p>Aspose.Words automatically generates a unique file name for every resource when
- exporting to fixed page HTML or SVG format. How the resource file name is generated
- depends on whether you save the document to a file or to a stream.</p>
- <p>When saving a document to a file, the generated resource file name looks like
- <i><document base file name>.<image number>.<extension></i>.</p>
- <p>When saving a document to a stream, the generated resource file name looks like
- <i>Aspose.Words.<document guid>.<image number>.<extension></i>.</p>
- <para>
- <see cref="P:Aspose.Words.Saving.ResourceSavingArgs.ResourceFileName" /> must contain only the file name without the path.
- Aspose.Words determines the path for saving and the value of the <c>src</c> attribute for writing
- to fixed page HTML or SVG using the document file name, the <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolder" />
- or <see cref="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolder" /> and <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolderAlias" />
- or <see cref="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolderAlias" /> properties.</para>
- <seealso cref="P:Aspose.Words.Saving.ResourceSavingArgs.ResourceStream" />
- <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolder" />
- <see cref="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolder" />
- <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolderAlias" />
- <see cref="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolderAlias" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ResourceSavingArgs.ResourceFileUri">
- <summary>
- Gets or sets the uniform resource identifier (URI) used to reference the resource file from the document.
- </summary>
- <remarks>
- <para>This property allows you to change URIs of resource files exported to fixed page HTML or SVG documents.</para>
- <para>Aspose.Words automatically generates an URI for every resource file during export to fixed page HTML
- or SVG format. The generated URIs reference resource files saved by Aspose.Words. However, the URIs can be
- incorrect if resource files are to be moved to other location or if resource files are saved to streams.
- This property allows to correct URIs in these cases.</para>
- <para>When the event is fired, this property contains the URI that was generated
- by Aspose.Words. You can change the value of this property to provide a custom URI for the resource file.</para>
- <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolder" />
- <see cref="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolder" />
- <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolderAlias" />
- <see cref="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolderAlias" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ResourceSavingArgs.KeepResourceStreamOpen">
- <summary>
- Specifies whether Aspose.Words should keep the stream open or close it after saving a resource.
- </summary>
- <remarks>
- <para>Default is <c>false</c> and Aspose.Words will close the stream you provided
- in the <see cref="P:Aspose.Words.Saving.ResourceSavingArgs.ResourceStream" /> property after writing a resource into it.
- Specify <c>true</c> to keep the stream open.</para>
- <seealso cref="P:Aspose.Words.Saving.ResourceSavingArgs.ResourceStream" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ResourceSavingArgs.ResourceStream">
- <summary>
- Allows to specify the stream where the resource will be saved to.
- </summary>
- <remarks>
- <para>This property allows you to save resources to streams instead of files.</para>
- <para>The default value is <c>null</c>. When this property is <c>null</c>, the resource
- will be saved to a file specified in the <see cref="P:Aspose.Words.Saving.ResourceSavingArgs.ResourceFileName" /> property.</para>
- <para>Using <see cref="T:Aspose.Words.Saving.IResourceSavingCallback" /> you cannot substitute one resource with
- another. It is intended only for control over location where to save resources.</para>
- <seealso cref="P:Aspose.Words.Saving.ResourceSavingArgs.ResourceFileName" />
- <seealso cref="P:Aspose.Words.Saving.ResourceSavingArgs.KeepResourceStreamOpen" />
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.PdfPageMode">
- <summary>
- Specifies how the PDF document should be displayed when opened in the PDF reader.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPageMode.UseNone">
- <summary>
- Neither document outline nor thumbnail images are visible.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPageMode.UseOutlines">
- <summary>
- Document outline is visible.
- Note that if there're no outlines in the PDF document then outline navigation pane will not be visible anyway.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPageMode.UseThumbs">
- <summary>
- Thumbnail images are visible.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPageMode.FullScreen">
- <summary>
- Full-screen mode, with no menu bar, window controls, or any other window visible.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPageMode.UseOC">
- <summary>
- Optional content group panel is visible.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.HtmlFixedSaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.HtmlFixed" /> format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can only be <see cref="F:Aspose.Words.SaveFormat.HtmlFixed" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ShowPageBorder">
- <summary>
- Specifies whether border around pages should be shown.
- Default is <c>true</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.PageHorizontalAlignment">
- <summary>
- Specifies the horizontal alignment of pages in an HTML document.
- Default value is <c>HtmlFixedHorizontalPageAlignment.Center</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.PageMargins">
- <summary>
- Specifies the margins around pages in an HTML document.
- The margins value is measured in points and should be equal to or greater than 0.
- Default value is 10 points.
- </summary>
- <remarks>
- <para>Depends on the value of <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.PageHorizontalAlignment" /> property:</para>
- <list type="bullet">
- <item>
- Defines top, bottom and left page margins if the value is <see cref="F:Aspose.Words.Saving.HtmlFixedPageHorizontalAlignment.Left" />.
- </item>
- <item>
- Defines top, bottom and right page margins if the value is <see cref="F:Aspose.Words.Saving.HtmlFixedPageHorizontalAlignment.Right" />.
- </item>
- <item>
- Defines top and bottom page margins if the value is <see cref="F:Aspose.Words.Saving.HtmlFixedPageHorizontalAlignment.Center" />.
- </item>
- </list>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolder">
- <summary>
- Specifies the physical folder where resources (images, fonts, css) are saved when exporting a document to Html format.
- Default is <c>null</c>.
- </summary>
- <remarks>
- <p>Has effect only if <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ExportEmbeddedImages" /> property is false.</p>
- <p>When you save a <see cref="T:Aspose.Words.Document" /> in Html format, Aspose.Words needs to save all
- images embedded in the document as standalone files. <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolder" />
- allows you to specify where the images will be saved and <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolderAlias" />
- allows to specify how the image URIs will be constructed.</p>
- <p>If you save a document into a file and provide a file name, Aspose.Words, by default, saves the
- images in the same folder where the document file is saved. Use <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolder" />
- to override this behavior.</p>
- <p>If you save a document into a stream, Aspose.Words does not have a folder where to save the images,
- but still needs to save the images somewhere. In this case, you need to specify an accessible folder
- by using the <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolder" /> property</p>
- <seealso cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolderAlias" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolderAlias">
- <summary>
- Specifies the name of the folder used to construct image URIs written into an Html document.
- Default is <c>null</c>.
- </summary>
- <remarks>
- <p>When you save a <see cref="T:Aspose.Words.Document" /> in Html format, Aspose.Words needs to save all
- images embedded in the document as standalone files. <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolder" />
- allows you to specify where the images will be saved and <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolderAlias" />
- allows to specify how the image URIs will be constructed.</p>
- <seealso cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourcesFolder" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ExportEmbeddedImages">
- <summary>
- Specifies whether images should be embedded into Html document in Base64 format.
- Note setting this flag can significantly increase size of output Html file.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ExportEmbeddedFonts">
- <summary>
- Specifies whether fonts should be embedded into Html document in Base64 format.
- Note setting this flag can significantly increase size of output Html file.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ExportEmbeddedCss">
- <summary>
- Specifies whether the CSS (Cascading Style Sheet) should be embedded into Html document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ExportEmbeddedSvg">
- <summary>
- Specifies whether SVG resources should be embedded into Html document.
- Default value is <c>true</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.FontFormat">
- <summary>
- Gets or sets <see cref="T:Aspose.Words.Saving.ExportFontFormat" /> used for font exporting.
- Default value is <see cref="F:Aspose.Words.Saving.ExportFontFormat.Woff" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.CssClassNamesPrefix">
- <summary>
- Specifies prefix which is added to all class names in style.css file.
- Default value is <c>"aw"</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourceSavingCallback">
- <summary>
- Allows to control how resources (images, fonts and css) are saved when a document is exported to fixed page Html format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.Encoding">
- <summary>
- Specifies the encoding to use when exporting to HTML.
- Default value is <c>new UTF8Encoding(true)</c> (UTF-8 with BOM).
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ExportFormFields">
- <summary>
- Gets or sets indication of whether form fields are exported as interactive
- items (as 'input' tag) rather than converted to text or graphics.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.OptimizeOutput">
- <summary>
- Flag indicates whether it is required to optimize output.
- If this flag is set redundant nested canvases and empty canvases are removed,
- also neighbor glyphs with the same formating are concatenated.
- Note: The accuracy of the content display may be affected if this property is set to true.
-
- Default is true.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.UseTargetMachineFonts">
- <summary>
- Flag indicates whether fonts from target machine must be used to display the document.
- If this flag is set to true, <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.FontFormat" /> and <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ExportEmbeddedFonts" /> properties do not have effect,
- also <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ResourceSavingCallback" /> is not fired for fonts.
- Default is false.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlFixedSaveOptions.SaveFontFaceCssSeparately">
- <summary>
- Flag indicates whether "@font-face" CSS rules should be placed into a separate file "fontFaces.css"
- when a document is being saved with external stylesheet (that is, when <see cref="P:Aspose.Words.Saving.HtmlFixedSaveOptions.ExportEmbeddedCss" />
- is <c>false</c>).
- Default value is <c>false</c>, all CSS rules are written into single file "styles.css".
- </summary>
- <remarks>
- Setting this property to <c>true</c> restores the old behavior (separate files) for compatibility with legacy code.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.BookmarksOutlineLevelCollection">
- <summary>
- A collection of individual bookmarks outline level.
- </summary>
- <remarks>
- <para>Key is a case-insensitive string bookmark name. Value is a int bookmark outline level.</para>
- <para>Bookmark outline level may be a value from 0 to 9. Specify 0 and Word bookmark will not be displayed in the document outline.
- Specify 1 and Word bookmark will be displayed in the document outline at level 1; 2 for level 2 and so on.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Saving.BookmarksOutlineLevelCollection.Add(System.String,System.Int32)">
- <summary>
- Adds a bookmark to the collection.
- </summary>
- <param name="name">The case-insensitive name of the bookmark to add.</param>
- <param name="outlineLevel">The outline level of the bookmark. Valid range is 0 to 9.</param>
- </member>
- <member name="M:Aspose.Words.Saving.BookmarksOutlineLevelCollection.Contains(System.String)">
- <summary>
- Determines whether the collection contains a bookmark with the given name.
- </summary>
- <param name="name">Case-insensitive name of the bookmark to locate.</param>
- <returns>True if item is found in the collection; otherwise, false.</returns>
- </member>
- <member name="M:Aspose.Words.Saving.BookmarksOutlineLevelCollection.IndexOfKey(System.String)">
- <summary>
- Returns the zero-based index of the specified bookmark in the collection.
- </summary>
- <param name="name">The case-insensitive name of the bookmark.</param>
- <returns>The zero based index. Negative value if not found.</returns>
- </member>
- <member name="M:Aspose.Words.Saving.BookmarksOutlineLevelCollection.Remove(System.String)">
- <summary>
- Removes a bookmark with the specified name from the collection.
- </summary>
- <param name="name">The case-insensitive name of the bookmark.</param>
- </member>
- <member name="M:Aspose.Words.Saving.BookmarksOutlineLevelCollection.RemoveAt(System.Int32)">
- <summary>
- Removes a bookmark at the specified index.
- </summary>
- <param name="index">The zero based index.</param>
- </member>
- <member name="M:Aspose.Words.Saving.BookmarksOutlineLevelCollection.Clear">
- <summary>
- Removes all elements from the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.BookmarksOutlineLevelCollection.Count">
- <summary>
- Gets the number of elements contained in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.BookmarksOutlineLevelCollection.Item(System.String)">
- <overloads>Provides access to the collection items.</overloads>
- <summary>
- Gets or a sets a bookmark outline level by the bookmark name.
- </summary>
- <param name="name">Case-insensitive name of the bookmark.</param>
- <returns>The outline level of the bookmark. Valid range is 0 to 9.</returns>
- </member>
- <member name="P:Aspose.Words.Saving.BookmarksOutlineLevelCollection.Item(System.Int32)">
- <summary>
- Gets or sets a bookmark outline level at the specified index.
- </summary>
- <param name="index">Zero-based index of the bookmark.</param>
- <returns>The outline level of the bookmark. Valid range is 0 to 9.</returns>
- </member>
- <member name="T:Aspose.Words.Saving.IResourceSavingCallback">
- <summary>
- 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.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.IResourceSavingCallback.ResourceSaving(Aspose.Words.Saving.ResourceSavingArgs)">
- <summary>
- Called when Aspose.Words saves an external resource to fixed page HTML or SVG formats.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.OutlineOptions">
- <summary>
- Allows to specify outline options.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.OutlineOptions.CreateMissingOutlineLevels">
- <summary>
- <para>Gets or sets a value determining whether or not to create missing outline levels when the document is
- exported.</para>
- <para>Default value for this property is <b>false</b>.</para>
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.OutlineOptions.HeadingsOutlineLevels">
- <summary>
- Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the
- document outline.
- </summary>
- <remarks>
- <para>Specify 0 for no headings in the outline; specify 1 for one level of headings in the outline and so on.</para>
- <para>Default is 0. Valid range is 0 to 9.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.OutlineOptions.ExpandedOutlineLevels">
- <summary>
- Specifies how many levels in the document outline to show expanded when the file is viewed.
- </summary>
- <remarks>
- <para>Note that this options will not work when saving to XPS.</para>
- <para>Specify 0 and the document outline will be collapsed; specify 1 and the first level items
- in the outline will be expanded and so on.</para>
- <para>Default is 0. Valid range is 0 to 9.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.OutlineOptions.DefaultBookmarksOutlineLevel">
- <summary>
- Specifies the default level in the document outline at which to display Word bookmarks.
- </summary>
- <remarks>
- <para>Individual bookmarks level could be specified using <see cref="P:Aspose.Words.Saving.OutlineOptions.BookmarksOutlineLevels" /> property.</para>
- <para>Specify 0 and Word bookmarks will not be displayed in the document outline.
- Specify 1 and Word bookmarks will be displayed in the document outline at level 1; 2 for level 2 and so on.</para>
- <para>Default is 0. Valid range is 0 to 9.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.OutlineOptions.BookmarksOutlineLevels">
- <summary>
- Allows to specify individual bookmarks outline level.
- </summary>
- <remarks>
- <para>If bookmark level is not specified in this collection then <see cref="P:Aspose.Words.Saving.OutlineOptions.DefaultBookmarksOutlineLevel" /> value is used.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.OutlineOptions.CreateOutlinesForHeadingsInTables">
- <summary>
- Specifies whether or not to create outlines for headings (paragraphs formatted with the Heading styles) inside tables.
- </summary>
- <remarks>
- <para>Default value is <b>false</b>.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.PdfImageCompression">
- <summary>
- Specifies the type of compression applied to images in the PDF file.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfImageCompression.Auto">
- <summary>
- Automatically selects the most appropriate compression for each image.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfImageCompression.Jpeg">
- <summary>
- Jpeg compression.
- Does not support transparency.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.CssSavingArgs">
- <summary>
- Provides data for the <see cref="M:Aspose.Words.Saving.ICssSavingCallback.CssSaving(Aspose.Words.Saving.CssSavingArgs)" /> event.
- </summary>
- <remarks>
- <para>By default, when Aspose.Words saves a document to HTML, it saves CSS information inline
- (as a value of the <b>style</b> attribute on every element).
- </para>
- <para>
- <see cref="T:Aspose.Words.Saving.CssSavingArgs" /> allows to save CSS information into file by providing your own stream object.</para>
- <para>To save CSS into stream, use the <see cref="P:Aspose.Words.Saving.CssSavingArgs.CssStream" /> property.</para>
- <para>To suppress saving CSS into a file and embedding to HTML document use the <see cref="P:Aspose.Words.Saving.CssSavingArgs.IsExportNeeded" /> property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.CssSavingArgs.Document">
- <summary>
- Gets the document object that is currently being saved.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.CssSavingArgs.KeepCssStreamOpen">
- <summary>
- Specifies whether Aspose.Words should keep the stream open or close it after saving an CSS information.
- </summary>
- <remarks>
- <para>Default is <c>false</c> and Aspose.Words will close the stream you provided
- in the <see cref="P:Aspose.Words.Saving.CssSavingArgs.CssStream" /> property after writing an CSS information into it.
- Specify <c>true</c> to keep the stream open.</para>
- <seealso cref="P:Aspose.Words.Saving.CssSavingArgs.CssStream" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.CssSavingArgs.CssStream">
- <summary>
- Allows to specify the stream where the CSS information will be saved to.
- </summary>
- <remarks>
- <para>This property allows you to save CSS information to a stream.</para>
- <para>The default value is <c>null</c>. This property doesn't suppress saving CSS information to a file or
- embedding to HTML document. To suppress exporting CSS use the <see cref="P:Aspose.Words.Saving.CssSavingArgs.IsExportNeeded" /> property.</para>
- <para>Using <see cref="T:Aspose.Words.Saving.ICssSavingCallback" /> you cannot substitute CSS with
- another. It is intended only for saving CSS to a stream.</para>
- <seealso cref="P:Aspose.Words.Saving.CssSavingArgs.KeepCssStreamOpen" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.CssSavingArgs.IsExportNeeded">
- <summary>
- Allows to specify whether the CSS will be exported to file and embedded to HTML document. Default is <c>true</c>.
- When this property is <c>false</c>, the CSS information will not be saved to a CSS file and will not be embedded to HTML document.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.ICssSavingCallback">
- <summary>
- Implement this interface if you want to control how Aspose.Words saves CSS (Cascading Style Sheet) when
- saving a document to HTML.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.ICssSavingCallback.CssSaving(Aspose.Words.Saving.CssSavingArgs)">
- <summary>
- Called when Aspose.Words saves an CSS (Cascading Style Sheet).
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.EmfPlusDualRenderingMode">
- <summary>
- Specifies how Aspose.Words should render EMF+ Dual metafiles.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.EmfPlusDualRenderingMode.EmfPlusWithFallback">
- <summary>
- Aspose.Words tries to render EMF+ part of EMF+ Dual metafile. If some of the EMF+ records are not supported
- then Aspose.Words renders EMF part of EMF+ Dual metafile.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.EmfPlusDualRenderingMode.EmfPlus">
- <summary>
- Aspose.Words renders EMF+ part of EMF+ Dual metafile.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.EmfPlusDualRenderingMode.Emf">
- <summary>
- Aspose.Words renders EMF part of EMF+ Dual metafile.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.MetafileRenderingOptions">
- <summary>
- Allows to specify additional metafile rendering options.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.MetafileRenderingOptions.RenderingMode">
- <summary>
- Gets or sets a value determining how metafile images should be rendered.
- </summary>
- <remarks>
- <para>The default value depends on the save format. For images it is <see cref="F:Aspose.Words.Saving.MetafileRenderingMode.Bitmap" />.
- For other formats it is <see cref="F:Aspose.Words.Saving.MetafileRenderingMode.VectorWithFallback" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.MetafileRenderingOptions.EmfPlusDualRenderingMode">
- <summary>
- Gets or sets a value determining how EMF+ Dual metafiles should be rendered.
- </summary>
- <remarks>
- <para>EMF+ Dual metafiles contains both EMF+ and EMF parts. MS Word and GDI+ always renders EMF+ part.
- Aspose.Words currently doesn't fully supports all EMF+ records and in some cases rendering result of
- EMF part looks better then rendering result of EMF+ part.</para>
- <p>This option is used only when metafile is rendered as vector graphics. When metafile is rendered
- to bitmap, EMF+ part is always used.</p>
- <p>The default value is <see cref="F:Aspose.Words.Saving.EmfPlusDualRenderingMode.EmfPlusWithFallback" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.MetafileRenderingOptions.UseEmfEmbeddedToWmf">
- <summary>
- Gets or sets a value determining how WMF metafiles with embedded EMF metafiles should be rendered.
- </summary>
- <remarks>
- <para>WMF metafiles could contain embedded EMF data. MS Word in most cases uses embedded EMF data.
- GDI+ always uses WMF data.</para>
- <p>When this value is set to <c>true</c>, Aspose.Words uses embedded EMF data when rendering.</p>
- <p>When this value is set to <c>false</c>, Aspose.Words uses WMF data when rendering.</p>
- <p>This option is used only when metafile is rendered as vector graphics. When metafile is rendered
- to bitmap, WMF data is always used.</p>
- <p>The default value is <c>true</c>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.MetafileRenderingOptions.EmulateRasterOperations">
- <summary>
- Gets or sets a value determining whether or not the raster operations should be emulated.
- </summary>
- <remarks>
- <para>Specific raster operations could be used in metafiles. They can not be rendered directly to vector graphics.
- Emulating raster operations requires partial rasterization of the resulting vector graphics which may affect the
- metafile rendering performance.
- </para>
- <p>When this value is set to <c>true</c>, Aspose.Words emulates the raster operations. The resulting output maybe
- partially rasterized and performance might be slower.</p>
- <p>When this value is set to <c>false</c>, Aspose.Words does not emulate the raster operations. When Aspose.Words
- encounters a raster operation in a metafile it fallbacks to rendering the metafile into a bitmap by using the
- operating system.</p>
- <p>This option is used only when metafile is rendered as vector graphics.</p>
- <p>The default value is <c>true</c>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.MetafileRenderingOptions.ScaleWmfFontsToMetafileSize">
- <summary>
- Gets or sets a value determining whether or not to scale fonts in WMF metafile according to metafile size on the page.
- </summary>
- <remarks>
- <para>When WMF metafiles are displayed in MS Word, fonts may be scaled according to actual metafile size on the page.</para>
- <p>When this value is set to <c>true</c>, Aspose.Words emulates font scaling according to metafile size on the page.</p>
- <p>When this value is set to <c>false</c>, Aspose.Words displays the fonts as metafile is rendered to its default size.</p>
- <p>This option is used only when metafile is rendered as vector graphics.</p>
- <p>The default value is <c>true</c>.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.NumeralFormat">
- <summary>
- Indicates the symbol set that is used to represent numbers
- while rendering to fixed page formats.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.NumeralFormat.European">
- <summary>
- European numerals: 0123456789.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.NumeralFormat.ArabicIndic">
- <summary>
- Numerals used in Arabic: ٠١٢٣٤٥٦٧٨٩.
- Unicode range U+0660 - u+0669.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.NumeralFormat.EasternArabicIndic">
- <summary>
- Numerals used in Persian and Urdu: ۰۱۲۳۴۵۶۷۸۹.
- Unicode range U+06F0 - u+06F9.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.NumeralFormat.Context">
- <summary>
- Symbol set is decided from context(locale and RTL property).
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.NumeralFormat.System">
- <summary>
- THIS OPTION IS NOT SUPPORTED.
- Symbol set is decided from regional settings.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.PdfZoomBehavior">
- <summary>
- Specifies the type of zoom applied to a PDF document when it is opened in a PDF viewer.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfZoomBehavior.None">
- <summary>
- How the document is displayed is left to the PDF viewer. Usually the viewer displays the document to fit page width.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfZoomBehavior.ZoomFactor">
- <summary>
- Displays the page using the specified zoom factor.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfZoomBehavior.FitPage">
- <summary>
- Displays the page so it visible entirely.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfZoomBehavior.FitWidth">
- <summary>
- Fits the width of the page.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfZoomBehavior.FitHeight">
- <summary>
- Fits the height of the page.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfZoomBehavior.FitBox">
- <summary>
- Fits the bounding box (rectangle containing all visible elements on the page).
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.SvgSaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.Svg" /> format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.SvgSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can only be <see cref="F:Aspose.Words.SaveFormat.Svg" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.SvgSaveOptions.ShowPageBorder">
- <summary>
- Controls whether a border is added to the outline of the page.
- Default is <c>true</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.SvgSaveOptions.TextOutputMode">
- <summary>
- Gets or sets a value determining how text should be rendered in SVG.
- </summary>
- <remarks>
- <p>Use this property to get or set the mode of how text inside a document should be rendered
- when saving in SVG format.</p>
- <p>The default value is <see cref="F:Aspose.Words.Saving.SvgTextOutputMode.UseTargetMachineFonts" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolder">
- <summary>
- Specifies the physical folder where resources (images) are saved when exporting a document to Svg format.
- Default is <c>null</c>.
- </summary>
- <remarks>
- <p>Has effect only if <see cref="P:Aspose.Words.Saving.SvgSaveOptions.ExportEmbeddedImages" /> property is false.</p>
- <p>When you save a <see cref="T:Aspose.Words.Document" /> in SVG format, Aspose.Words needs to save all
- images embedded in the document as standalone files. <see cref="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolder" />
- allows you to specify where the images will be saved and <see cref="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolderAlias" />
- allows to specify how the image URIs will be constructed.</p>
- <p>If you save a document into a file and provide a file name, Aspose.Words, by default, saves the
- images in the same folder where the document file is saved. Use <see cref="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolder" />
- to override this behavior.</p>
- <p>If you save a document into a stream, Aspose.Words does not have a folder where to save the images,
- but still needs to save the images somewhere. In this case, you need to specify an accessible folder
- in the <see cref="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolder" /> property</p>
- <seealso cref="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolderAlias" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolderAlias">
- <summary>
- Specifies the name of the folder used to construct image URIs written into an SVG document.
- Default is <c>null</c>.
- </summary>
- <remarks>
- <p>When you save a <see cref="T:Aspose.Words.Document" /> in SVG format, Aspose.Words needs to save all
- images embedded in the document as standalone files. <see cref="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolder" />
- allows you to specify where the images will be saved and <see cref="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolderAlias" />
- allows to specify how the image URIs will be constructed.</p>
- <seealso cref="P:Aspose.Words.Saving.SvgSaveOptions.ResourcesFolder" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.SvgSaveOptions.ExportEmbeddedImages">
- <summary>
- Specified whether images should be embedded into SVG document as base64.
- Note setting this flag can significantly increase size of output SVG file.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.SvgSaveOptions.FitToViewPort">
- <summary>
- Specifies if the output SVG should fill the available viewport area (browser window or container).
- When set to true width and height of output SVG are set to 100%.
-
- <p>The default value is false.</p></summary>
- </member>
- <member name="P:Aspose.Words.Saving.SvgSaveOptions.ResourceSavingCallback">
- <summary>
- Allows to control how resources (images) are saved when a document is exported to SVG format.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.SvgTextOutputMode">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.SvgTextOutputMode.UseSvgFonts">
- <summary>
- SVG fonts are used to render text. Note, not all browsers support SVG fonts.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.SvgTextOutputMode.UseTargetMachineFonts">
- <summary>
- Fonts installed on the target machine are used to render text.
- Note, if some of fonts used in the document are not available on the target machine, document can look differently.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.SvgTextOutputMode.UsePlacedGlyphs">
- <summary>
- Text is rendered using curves. Note, text selection will not work if you use this option.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.ExportListLabels">
- <summary>
- Specifies how list labels are exported to HTML, MHTML and EPUB.
- </summary>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ExportListLabels" />
- </member>
- <member name="F:Aspose.Words.Saving.ExportListLabels.Auto">
- <summary>
- Outputs list labels in auto mode. Uses HTML native elements when possible.
- </summary>
- <remarks>
- HTML <ul> and <ol> tags are used for list label representation if it doesn't cause formatting loss, otherwise the HTML <p> tag is used.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Saving.ExportListLabels.AsInlineText">
- <summary>
- Outputs all list labels as inline text.
- </summary>
- <remarks>
- HTML <p> tag is used for any list label representation.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Saving.ExportListLabels.ByHtmlTags">
- <summary>
- Outputs all list labels as HTML native elements.
- </summary>
- <remarks>
- HTML <ul> and <ol> tags are used for list label representation. Some formatting loss is possible.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.PdfDigitalSignatureHashAlgorithm">
- <summary>
- Specifies a digital hash algorithm used by a digital signature.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfDigitalSignatureHashAlgorithm.Sha1">
- <summary>
- SHA-1 hash algorithm.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfDigitalSignatureHashAlgorithm.Sha256">
- <summary>
- SHA-256 hash algorithm.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfDigitalSignatureHashAlgorithm.Sha384">
- <summary>
- SHA-384 hash algorithm.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfDigitalSignatureHashAlgorithm.Sha512">
- <summary>
- SHA-512 hash algorithm.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfDigitalSignatureHashAlgorithm.Md5">
- <summary>
- SHA-1 hash algorithm.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.ExportHeadersFootersMode">
- <summary>
- Specifies how headers and footers are exported to HTML, MHTML or EPUB.
- </summary>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ExportHeadersFootersMode" />
- </member>
- <member name="F:Aspose.Words.Saving.ExportHeadersFootersMode.None">
- <summary>
- Headers and footers are not exported.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ExportHeadersFootersMode.PerSection">
- <summary>
- Primary headers and footers are exported at the beginning and the end of each section.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ExportHeadersFootersMode.FirstSectionHeaderLastSectionFooter">
- <summary>
- Primary header of the first section is exported at the beginning of the document and primary footer is at the end.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ExportHeadersFootersMode.FirstPageHeaderFooterPerSection">
- <summary>
- First page header and footer are exported at the beginning and the end of each section.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.HtmlElementSizeOutputMode">
- <summary>
- Specifies how Aspose.Words exports element widths and heights to HTML, MHTML and EPUB.
- </summary>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.TableWidthOutputMode" />
- </member>
- <member name="F:Aspose.Words.Saving.HtmlElementSizeOutputMode.All">
- <summary>
- All element sizes, both in absolute and relative units, specified in the document are exported.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HtmlElementSizeOutputMode.RelativeOnly">
- <summary>
- Element sizes are exported only if they are specified in relative units in the document.
- Fixed sizes are not exported in this mode. Visual agents will calculate missing sizes to make
- document layout more natural.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.HtmlElementSizeOutputMode.None">
- <summary>
- Element sizes are not exported. Visual agents will build layout automatically according to relationship between elements.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.PageRange">
- <summary>
- Represents a continuous range of pages.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.PageRange.#ctor(System.Int32,System.Int32)">
- <summary>
- Creates a new page range object.
- </summary>
- <param name="from">
- The starting page zero-based index.
- </param>
- <param name="to">
- The ending page zero-based index.
- If it exceeds the index of the last page in the document,
- it is truncated to fit in the document on rendering.
- </param>
- <remarks>
- <see cref="F:System.Int32.MaxValue" /> means the last page in the document.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.PdfEncryptionAlgorithm">
- <summary>
- Specifies the encryption algorithm to use for encrypting a PDF document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfEncryptionAlgorithm.RC4_40">
- <summary>
- RC4 encryption, key length of 40 bits.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfEncryptionAlgorithm.RC4_128">
- <summary>
- RC4 encryption, key length of 128 bits.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.PdfEncryptionDetails">
- <summary>
- Contains details for encrypting and access permissions for a PDF document.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.PdfEncryptionDetails.#ctor(System.String,System.String,Aspose.Words.Saving.PdfEncryptionAlgorithm)">
- <summary>
- Initializes an instance of this class.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.PdfEncryptionDetails.UserPassword">
- <summary>
- Specifies the user password required for opening the encrypted PDF document.
- </summary>
- <remarks>
- <para>The user password will be required to open an encrypted PDF document for viewing. The permissions specified in
- <see cref="P:Aspose.Words.Saving.PdfEncryptionDetails.Permissions" /> will be enforced by the reader software.</para>
- <para>The user password can be null or empty string, in this case no password will be required from the user when
- opening the PDF document. The user password cannot be the same as the owner password.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfEncryptionDetails.OwnerPassword">
- <summary>
- Specifies the owner password for the encrypted PDF document.
- </summary>
- <remarks>
- <para>The owner password allows the user to open an encrypted PDF document without any access restrictions
- specified in <see cref="P:Aspose.Words.Saving.PdfEncryptionDetails.Permissions" />.</para>
- <para>The owner password cannot be the same as the user password.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfEncryptionDetails.Permissions">
- <summary>
- Specifies the operations that are allowed to a user on an encrypted PDF document.
- The default value is <see cref="F:Aspose.Words.Saving.PdfPermissions.DisallowAll" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.PdfEncryptionDetails.EncryptionAlgorithm">
- <summary>
- Specifies the encryption algorithm to use.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.MetafileRenderingMode">
- <summary>
- Specifies how Aspose.Words should render WMF and EMF metafiles.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.MetafileRenderingMode.VectorWithFallback">
- <summary>
- Aspose.Words tries to render a metafile as vector graphics. If Aspose.Words cannot correctly render some of
- the metafile records to vector graphics then Aspose.Words renders this metafile to a bitmap.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.MetafileRenderingMode.Vector">
- <summary>
- Aspose.Words renders a metafile as vector graphics.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.MetafileRenderingMode.Bitmap">
- <summary>
- Aspose.Words invokes GDI+ to render a metafile to a bitmap and then saves the bitmap to the output document.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.PdfPermissions">
- <summary>
- Specifies the operations that are allowed to a user on an encrypted PDF document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPermissions.DisallowAll">
- <summary>
- Disallows all operations on the PDF document.
- This is the default value.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPermissions.AllowAll">
- <summary>
- Allows all operations on the PDF document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPermissions.ContentCopy">
- <summary>
- Allows copying or otherwise extracting text and graphics from the document, including extraction for accessibility purposes.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPermissions.ContentCopyForAccessibility">
- <summary>
- Allows extract text and graphics in support of accessibility to disabled users or for other purposes.
-
- When using RC4 40-bit encryption, this option is ignored and accessibility is allowed whenever <see cref="F:Aspose.Words.Saving.PdfPermissions.ContentCopy" /> is set.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPermissions.ModifyContents">
- <summary>
- Allows modifying the document’s contents.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPermissions.ModifyAnnotations">
- <summary>
- Allows adding or modifying text annotations.
-
- When using RC4 40-bit encryption, this option also allows filling in form fields.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPermissions.FillIn">
- <summary>
- Allows filling in forms and signing the document.
-
- When using RC4 40-bit encryption, this option is ignored and filling in form is allowed whenever <see cref="F:Aspose.Words.Saving.PdfPermissions.ModifyAnnotations" /> is set.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPermissions.DocumentAssembly">
- <summary>
- Allows assembling the document: inserting, rotating, or deleting pages and creating
- navigation elements such as bookmarks or thumbnail images.
-
- When using RC4 40-bit encryption, this option is ignored and document assembly is allowed when <see cref="F:Aspose.Words.Saving.PdfPermissions.ModifyContents" /> is set.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPermissions.Printing">
- <summary>
- Allows printing the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfPermissions.HighResolutionPrinting">
- <summary>
- Allows printing the document to the highest resolution possible.
-
- When using RC4 40-bit encryption, this option is ignored and high resolution printing is allowed when <see cref="F:Aspose.Words.Saving.PdfPermissions.Printing" /> is set.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.XamlFixedSaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.XamlFixed" /> format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.XamlFixedSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can only be <see cref="F:Aspose.Words.SaveFormat.XamlFixed" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.XamlFixedSaveOptions.ResourcesFolder">
- <summary>
- Specifies the physical folder where resources (images and fonts) are saved when exporting a document to fixed page Xaml format.
- Default is <c>null</c>.
- </summary>
- <remarks>
- <p>When you save a <see cref="T:Aspose.Words.Document" /> in fixed page Xaml format, Aspose.Words needs to save all
- images embedded in the document as standalone files. <see cref="P:Aspose.Words.Saving.XamlFixedSaveOptions.ResourcesFolder" />
- allows you to specify where the images will be saved and <see cref="P:Aspose.Words.Saving.XamlFixedSaveOptions.ResourcesFolderAlias" />
- allows to specify how the image URIs will be constructed.</p>
- <p>If you save a document into a file and provide a file name, Aspose.Words, by default, saves the
- images in the same folder where the document file is saved. Use <see cref="P:Aspose.Words.Saving.XamlFixedSaveOptions.ResourcesFolder" />
- to override this behavior.</p>
- <p>If you save a document into a stream, Aspose.Words does not have a folder where to save the images,
- but still needs to save the images somewhere. In this case, you need to specify an accessible folder
- by using the <see cref="P:Aspose.Words.Saving.XamlFixedSaveOptions.ResourcesFolder" /> property</p>
- <seealso cref="P:Aspose.Words.Saving.XamlFixedSaveOptions.ResourcesFolderAlias" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.XamlFixedSaveOptions.ResourcesFolderAlias">
- <summary>
- Specifies the name of the folder used to construct image URIs written into an fixed page Xaml document.
- Default is <c>null</c>.
- </summary>
- <remarks>
- <p>When you save a <see cref="T:Aspose.Words.Document" /> in fixed page Xaml format, Aspose.Words needs to save all
- images embedded in the document as standalone files. <see cref="P:Aspose.Words.Saving.XamlFixedSaveOptions.ResourcesFolder" />
- allows you to specify where the images will be saved and <see cref="P:Aspose.Words.Saving.XamlFixedSaveOptions.ResourcesFolderAlias" />
- allows to specify how the image URIs will be constructed.</p>
- <seealso cref="P:Aspose.Words.Saving.XamlFixedSaveOptions.ResourcesFolder" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.XamlFixedSaveOptions.ResourceSavingCallback">
- <summary>
- Allows to control how resources (images and fonts) are saved when a document is exported to fixed page Xaml format.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.PdfDigitalSignatureDetails">
- <summary>
- Contains details for signing a PDF document with a digital signature.
- </summary>
- <remarks>
- <para>At the moment digitally signing PDF documents is only available on .NET 2.0 or higher.</para>
- <para>To digitally sign a PDF document when it is created by Aspose.Words, set the <see cref="P:Aspose.Words.Saving.PdfSaveOptions.DigitalSignatureDetails" />
- property to a valid <see cref="T:Aspose.Words.Saving.PdfDigitalSignatureDetails" /> object and then save the document in the PDF format passing
- the <see cref="T:Aspose.Words.Saving.PdfSaveOptions" /> as a parameter into the <see cref="M:Aspose.Words.Document.Save(System.String,Aspose.Words.Saving.SaveOptions)" /> method.</para>
- <para>Aspose.Words creates a PKCS#7 signature over the whole PDF document and uses the "Adobe.PPKMS" filter and
- "adbe.pkcs7.sha1" subfilter when creating a digital signature.</para>
- <seealso cref="P:Aspose.Words.Saving.PdfSaveOptions.DigitalSignatureDetails" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Saving.PdfDigitalSignatureDetails.#ctor">
- <summary>
- Initializes an instance of this class.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.PdfDigitalSignatureDetails.#ctor(Aspose.Words.CertificateHolder,System.String,System.String,System.DateTime)">
- <summary>
- Initializes an instance of this class.
- </summary>
- <param name="certificateHolder">A certificate holder which contains the certificate itself.</param>
- <param name="reason">The reason for signing.</param>
- <param name="location">The location of signing.</param>
- <param name="signatureDate">The date and time of signing.</param>
- </member>
- <member name="P:Aspose.Words.Saving.PdfDigitalSignatureDetails.CertificateHolder">
- <summary>
- Returns the certificate holder object that contains the certificate was used to sign the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.PdfDigitalSignatureDetails.Reason">
- <summary>
- Gets or sets the reason for the signing.
- </summary>
- <remarks>
- The default value is null.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfDigitalSignatureDetails.Location">
- <summary>
- Gets or sets the location of the signing.
- </summary>
- <remarks>
- The default value is null.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfDigitalSignatureDetails.SignatureDate">
- <summary>
- Gets or sets the date of the signing.
- </summary>
- <remarks>
- <para>The default value is the current time.</para>
- <para>This value will appear in the digital signature as an unverified computer time.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfDigitalSignatureDetails.HashAlgorithm">
- <summary>
- Gets or sets the hash algorithm.
- </summary>
- <remarks>The default value is the SHA-512 algorithm.</remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfDigitalSignatureDetails.TimestampSettings">
- <summary>
- Gets or sets the digital signature timestamp settings.
- </summary>
- <remarks>
- <para>The default value is null and the digital signature will not be time-stamped.
- When this property is set to a valid <see cref="T:Aspose.Words.Saving.PdfDigitalSignatureTimestampSettings" /> object,
- then the digital signature in the PDF document will be time-stamped.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.DocSaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.Doc" /> or
- <see cref="F:Aspose.Words.SaveFormat.Dot" /> format.
- </summary>
- <remarks>
- <para>At the moment provides only the <see cref="P:Aspose.Words.Saving.DocSaveOptions.SaveFormat" /> property, but in the future will have
- other options added, such as an encryption password or digital signature settings.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Saving.DocSaveOptions.#ctor">
- <summary>
- Initializes a new instance of this class that can be used to save a document in the <see cref="F:Aspose.Words.SaveFormat.Doc" /> format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.DocSaveOptions.#ctor(Aspose.Words.SaveFormat)">
- <summary>
- Initializes a new instance of this class that can be used to save a document in the <see cref="F:Aspose.Words.SaveFormat.Doc" /> or
- <see cref="F:Aspose.Words.SaveFormat.Dot" /> format.
- </summary>
- <param name="saveFormat">Can be <see cref="F:Aspose.Words.SaveFormat.Doc" /> or <see cref="F:Aspose.Words.SaveFormat.Dot" />.</param>
- </member>
- <member name="P:Aspose.Words.Saving.DocSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can be <see cref="F:Aspose.Words.SaveFormat.Doc" /> or <see cref="F:Aspose.Words.SaveFormat.Dot" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.DocSaveOptions.Password">
- <summary>
- Gets/sets a password to encrypt document using RC4 encryption method.
- </summary>
- <remarks>
- <para>In order to save document without encryption this property should be null or empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.DocSaveOptions.SaveRoutingSlip">
- <summary>
- When <c>false</c>, RoutingSlip data is not saved to output document.
- Default value is <b>true</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.DocSaveOptions.AlwaysCompressMetafiles">
- <summary>
- When <c>false</c>, small metafiles are not compressed for performance reason.
- Default value is <b>true</b>, all metafiles are compressed regardless of its size.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.DocSaveOptions.SavePictureBullet">
- <summary>
- When <c>false</c>, PictureBullet data is not saved to output document.
- Default value is <b>true</b>.
- </summary>
- <remarks>
- <para>This option is provided for Word 97, which cannot work correctly with PictureBullet data.
- To remove PictureBullet data, set the option to "false".</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.DocumentPartSavingArgs">
- <summary>
- Provides data for the <see cref="M:Aspose.Words.Saving.IDocumentPartSavingCallback.DocumentPartSaving(Aspose.Words.Saving.DocumentPartSavingArgs)" /> callback.
- </summary>
- <remarks>
- <p>When Aspose.Words saves a document to HTML or related formats and <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.DocumentSplitCriteria" />
- is specified, the document is split into parts and by default, each document part is saved into a separate file.</p>
- <p>Class <see cref="T:Aspose.Words.Saving.DocumentPartSavingArgs" /> allows you to control how each document part will be saved.
- It allows to redefine how file names are generated or to completely circumvent saving of document parts into
- files by providing your own stream objects.</p>
- <p>To save document parts into streams instead of files, use the <see cref="P:Aspose.Words.Saving.DocumentPartSavingArgs.DocumentPartStream" /> property.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.DocumentPartSavingArgs.Document">
- <summary>
- Gets the document object that is being saved.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.DocumentPartSavingArgs.DocumentPartFileName">
- <summary>
- Gets or sets the file name (without path) where the document part will be saved to.
- </summary>
- <remarks>
- <p>This property allows you to redefine how the document part file names are generated
- during export to HTML or EPUB.</p>
- <p>When the callback is invoked, this property contains the file name that was generated
- by Aspose.Words. You can change the value of this property to save the document part into a
- different file. Note that the file name for each part must be unique.</p>
- <p>
- <see cref="P:Aspose.Words.Saving.DocumentPartSavingArgs.DocumentPartFileName" /> must contain only the file name without the path.
- Aspose.Words determines the path for saving using the document file name. If output document
- file name was not specified, for instance when saving to a stream, this file name is used only
- for referencing document parts. The same is true when saving to EPUB format.</p>
- <seealso cref="P:Aspose.Words.Saving.DocumentPartSavingArgs.DocumentPartStream" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.DocumentPartSavingArgs.KeepDocumentPartStreamOpen">
- <summary>
- Specifies whether Aspose.Words should keep the stream open or close it after saving a document part.
- </summary>
- <remarks>
- <p>Default is <c>false</c> and Aspose.Words will close the stream you provided
- in the <see cref="P:Aspose.Words.Saving.DocumentPartSavingArgs.DocumentPartStream" /> property after writing a document part into it.
- Specify <c>true</c> to keep the stream open. Please note that the main output stream
- provided in the call to <see cref="M:Aspose.Words.Document.Save(System.IO.Stream,Aspose.Words.SaveFormat)" /> or
- <see cref="M:Aspose.Words.Document.Save(System.IO.Stream,Aspose.Words.Saving.SaveOptions)" /> will never be closed by Aspose.Words
- even if <see cref="P:Aspose.Words.Saving.DocumentPartSavingArgs.KeepDocumentPartStreamOpen" /> is set to <c>false</c>.</p>
- <seealso cref="P:Aspose.Words.Saving.DocumentPartSavingArgs.DocumentPartStream" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.DocumentPartSavingArgs.DocumentPartStream">
- <summary>
- Allows to specify the stream where the document part will be saved to.
- </summary>
- <remarks>
- <p>This property allows you to save document parts to streams instead of files during HTML export.</p>
- <p>The default value is <c>null</c>. When this property is <c>null</c>, the document part
- will be saved to a file specified in the <see cref="P:Aspose.Words.Saving.DocumentPartSavingArgs.DocumentPartFileName" /> property.</p>
- <p>When saving to a stream in HTML format is requested by <see cref="M:Aspose.Words.Document.Save(System.IO.Stream,Aspose.Words.SaveFormat)" />
- or <see cref="M:Aspose.Words.Document.Save(System.IO.Stream,Aspose.Words.Saving.SaveOptions)" /> and first document part is about to be saved,
- Aspose.Words suggests here the main output stream initially passed by the caller.</p>
- <p>When saving to EPUB format that is a container format based on HTML, <see cref="P:Aspose.Words.Saving.DocumentPartSavingArgs.DocumentPartStream" /> cannot
- be specified because all subsidiary parts will be encapsulated into a single output package.</p>
- <seealso cref="P:Aspose.Words.Saving.DocumentPartSavingArgs.KeepDocumentPartStreamOpen" />
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.DocumentSplitCriteria">
- <summary>
- Specifies how the document is split into parts when saving to <see cref="F:Aspose.Words.SaveFormat.Html" />
- or <see cref="F:Aspose.Words.SaveFormat.Epub" /> format.
- </summary>
- <remarks>
- <p>
- <see cref="T:Aspose.Words.Saving.DocumentSplitCriteria" /> is a set of flags which can be combined. For instance you can split the document
- at page breaks and heading paragraphs in the same export operation.</p>
- <p>Different criteria can partially overlap. For instance, <b>Heading 1</b> style is frequently given
- <see cref="P:Aspose.Words.ParagraphFormat.PageBreakBefore" /> property so it falls under two criteria: <see cref="F:Aspose.Words.Saving.DocumentSplitCriteria.PageBreak" /> and
- <see cref="F:Aspose.Words.Saving.DocumentSplitCriteria.HeadingParagraph" />. Some section breaks can cause page breaks and so on.
- In typical cases specifying only one flag is the most practical option.</p>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.DocumentSplitCriteria" />
- </remarks>
- </member>
- <member name="F:Aspose.Words.Saving.DocumentSplitCriteria.None">
- <summary>
- The document is not split.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.DocumentSplitCriteria.PageBreak">
- <summary>
- The document is split into parts at explicit page breaks.
- A page break can be specified by a <see cref="F:Aspose.Words.ControlChar.PageBreak" /> character,
- a section break specifying start of new section on a new page,
- or a paragraph that has its <see cref="P:Aspose.Words.ParagraphFormat.PageBreakBefore" /> property set to <c>true</c>.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.DocumentSplitCriteria.ColumnBreak">
- <summary>
- The document is split into parts at column breaks.
- A column break can be specified by a <see cref="F:Aspose.Words.ControlChar.ColumnBreak" /> character or
- a section break specifying start of new section in a new column.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.DocumentSplitCriteria.SectionBreak">
- <summary>
- The document is split into parts at a section break of any type.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.DocumentSplitCriteria.HeadingParagraph">
- <summary>
- The document is split into parts at a paragraph formatted using a heading style <b>Heading 1</b>, <b>Heading 2</b> etc.
- Use together with <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.DocumentSplitHeadingLevel" /> to specify the heading levels
- (from 1 to the specified level) at which to split.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.FontSavingArgs">
- <summary>
- Provides data for the <see cref="M:Aspose.Words.Saving.IFontSavingCallback.FontSaving(Aspose.Words.Saving.FontSavingArgs)" /> event.
- </summary>
- <remarks>
- <para>When Aspose.Words saves a document to HTML or related formats and <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ExportFontResources" />
- is set to <b>true</b>, it saves each font subject for export into a separate file.</para>
- <para>
- <see cref="T:Aspose.Words.Saving.FontSavingArgs" /> controls whether particular font resource should be exported and how.</para>
- <para>
- <see cref="T:Aspose.Words.Saving.FontSavingArgs" /> also allows to redefine how font file names are generated or to
- completely circumvent saving of fonts into files by providing your own stream objects.</para>
- <para>To decide whether to save a particular font resource, use the <see cref="P:Aspose.Words.Saving.FontSavingArgs.IsExportNeeded" /> property.</para>
- <para>To save fonts into streams instead of files, use the <see cref="P:Aspose.Words.Saving.FontSavingArgs.FontStream" /> property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.FontSavingArgs.Document">
- <summary>
- Gets the document object that is being saved.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.FontSavingArgs.FontFamilyName">
- <summary>
- Indicates the current font family name.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.FontSavingArgs.Bold">
- <summary>
- Indicates whether the current font is bold.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.FontSavingArgs.Italic">
- <summary>
- Indicates whether the current font is italic.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.FontSavingArgs.OriginalFileName">
- <summary>
- Gets the original font file name with an extension.
- </summary>
- <remarks>
- <p>This property contains the original file name of the current font if it is known. Otherwise it can be an empty string.</p>
- <seealso cref="P:Aspose.Words.Saving.FontSavingArgs.OriginalFileSize" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.FontSavingArgs.OriginalFileSize">
- <summary>
- Gets the original font file size.
- </summary>
- <remarks>
- <p>This property contains the original file size of the current font if it is known. Otherwise it can be zero.</p>
- <seealso cref="P:Aspose.Words.Saving.FontSavingArgs.OriginalFileName" />
- <seealso cref="P:Aspose.Words.Saving.FontSavingArgs.IsSubsettingNeeded" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.FontSavingArgs.IsExportNeeded">
- <summary>
- Allows to specify whether the current font will be exported as a font resource. Default is <c>true</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.FontSavingArgs.IsSubsettingNeeded">
- <summary>
- Allows to specify whether the current font will be subsetted before exporting as a font resource.
- </summary>
- <remarks>
- <p>Fonts can be exported as complete original font files or subsetted to include only the characters
- that are used in the document. Subsetting allows to reduce the resulting font resource size.</p>
- <para>By default, Aspose.Words decides whether to perform subsetting or not by comparing the original font file size
- with the one specified in <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontResourcesSubsettingSizeThreshold" />.
- You can override this behavior for individual fonts by setting the <see cref="P:Aspose.Words.Saving.FontSavingArgs.IsSubsettingNeeded" /> property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.FontSavingArgs.FontFileName">
- <summary>
- Gets or sets the file name (without path) where the font will be saved to.
- </summary>
- <remarks>
- <para>This property allows you to redefine how the font file names are generated
- during export to HTML.</para>
- <para>When the event is fired, this property contains the file name that was generated
- by Aspose.Words. You can change the value of this property to save the font into a
- different file. Note that file names must be unique.</para>
- <p>Aspose.Words automatically generates a unique file name for every embedded font when
- exporting to HTML format. How the font file name is generated
- depends on whether you save the document to a file or to a stream.</p>
- <p>When saving a document to a file, the generated font file name looks like
- <i><document base file name>.<original file name><optional suffix>.<extension></i>.</p>
- <p>When saving a document to a stream, the generated font file name looks like
- <i>Aspose.Words.<document guid>.<original file name><optional suffix>.<extension></i>.</p>
- <para>
- <see cref="P:Aspose.Words.Saving.FontSavingArgs.FontFileName" /> must contain only the file name without the path.
- Aspose.Words determines the path for saving using the document file name,
- the <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolder" /> and
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolderAlias" /> properties.</para>
- <seealso cref="P:Aspose.Words.Saving.FontSavingArgs.FontStream" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolder" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolderAlias" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.FontSavingArgs.KeepFontStreamOpen">
- <summary>
- Specifies whether Aspose.Words should keep the stream open or close it after saving a font.
- </summary>
- <remarks>
- <para>Default is <c>false</c> and Aspose.Words will close the stream you provided
- in the <see cref="P:Aspose.Words.Saving.FontSavingArgs.FontStream" /> property after writing a font into it.
- Specify <c>true</c> to keep the stream open.</para>
- <seealso cref="P:Aspose.Words.Saving.FontSavingArgs.FontStream" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.FontSavingArgs.FontStream">
- <summary>
- Allows to specify the stream where the font will be saved to.
- </summary>
- <remarks>
- <para>This property allows you to save fonts to streams instead of files during HTML export.</para>
- <para>The default value is <c>null</c>. When this property is <c>null</c>, the font
- will be saved to a file specified in the <see cref="P:Aspose.Words.Saving.FontSavingArgs.FontFileName" /> property.</para>
- <seealso cref="P:Aspose.Words.Saving.FontSavingArgs.FontFileName" />
- <seealso cref="P:Aspose.Words.Saving.FontSavingArgs.KeepFontStreamOpen" />
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.HtmlSaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.Html" />,
- <see cref="F:Aspose.Words.SaveFormat.Mhtml" /> or <see cref="F:Aspose.Words.SaveFormat.Epub" /> format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.HtmlSaveOptions.#ctor">
- <summary>
- Initializes a new instance of this class that can be used to save a document
- in the <see cref="F:Aspose.Words.SaveFormat.Html" /> format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.HtmlSaveOptions.#ctor(Aspose.Words.SaveFormat)">
- <summary>
- Initializes a new instance of this class that can be used to save a document
- in the <see cref="F:Aspose.Words.SaveFormat.Html" />, <see cref="F:Aspose.Words.SaveFormat.Mhtml" />
- or <see cref="F:Aspose.Words.SaveFormat.Epub" /> format.
- </summary>
- <param name="saveFormat">Can be <see cref="F:Aspose.Words.SaveFormat.Html" />, <see cref="F:Aspose.Words.SaveFormat.Mhtml" />
- or <see cref="F:Aspose.Words.SaveFormat.Epub" />.</param>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can be <see cref="F:Aspose.Words.SaveFormat.Html" />, <see cref="F:Aspose.Words.SaveFormat.Mhtml" />
- or <see cref="F:Aspose.Words.SaveFormat.Epub" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.AllowNegativeIndent">
- <summary>
- Specifies whether negative left and right indents of paragraphs are normalized
- when saving to HTML, MHTML or EPUB. Default value is <c>false</c>.
- </summary>
- <remarks>
- <para>When negative indent is not allowed, it is exported as zero margin to HTML.
- When negative indent is allowed, a paragraph might appear partially outside of the
- browser window.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.CssStyleSheetFileName">
- <summary>
- Specifies the path and the name of the Cascading Style Sheet (CSS) file written when a document
- is exported to HTML.
- Default is an empty string.
- </summary>
- <remarks>
- <para>This property has effect only when saving a document to HTML format
- and external CSS style sheet is requested using <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.CssStyleSheetType" />.</para>
- <para>If this property is empty, the CSS file will be saved into the same folder and with the same name as the HTML
- document but with the ".css" extension.</para>
- <para>If only path but no file name is specified in this property, the CSS file will be saved into the specified
- folder and will have the same name as the HTML document but with the ".css" extension.</para>
- <para>If the folder specified by this property doesn't exist, it will be created automatically before the CSS file
- is saved.</para>
- <para>Another way to specify a folder where external CSS file is saved is to use <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolder" />.
- </para>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolder" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolderAlias" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.CssStyleSheetType" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.CssStyleSheetType">
- <summary>
- Specifies how CSS (Cascading Style Sheet) styles are exported to HTML, MHTML or EPUB.
- Default value is <see cref="F:Aspose.Words.Saving.CssStyleSheetType.Inline" /> for HTML/MHTML and
- <see cref="F:Aspose.Words.Saving.CssStyleSheetType.External" /> for EPUB.
- </summary>
- <remarks>
- <para>Saving CSS style sheet into an external file is only supported when saving to HTML.
- When you are exporting to one of the container formats (EPUB or MHTML) and specifying
- <see cref="F:Aspose.Words.Saving.CssStyleSheetType.External" />, CSS file will be encapsulated
- into the output package.</para>
- </remarks>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.CssStyleSheetFileName" />
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.CssClassNamePrefix">
- <summary>
- Specifies a prefix which is added to all CSS class names.
- Default value is an empty string and generated CSS class names have no common prefix.
- </summary>
- <remarks>
- <para>If this value is not empty, all CSS classes generated by Aspose.Words will start with the specified prefix.
- This might be useful, for example, if you add custom CSS to generated documents and want to prevent class
- name conflicts.</para>
- <para>If the value is not <c>null</c> or empty, it must be a valid CSS identifier.</para>
- </remarks>
- <exception cref="T:System.ArgumentException">The value is not empty and is not a valid CSS identifier.</exception>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.DocumentPartSavingCallback">
- <summary>
- Allows to control how document parts are saved when a document is saved to HTML or EPUB.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.CssSavingCallback">
- <summary>
- Allows to control how CSS styles are saved when a document is saved to HTML, MHTML or EPUB.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.DocumentSplitCriteria">
- <summary>
- Specifies how the document should be split when saving to <see cref="F:Aspose.Words.SaveFormat.Html" />
- or <see cref="F:Aspose.Words.SaveFormat.Epub" /> format.
- Default is <see cref="F:Aspose.Words.Saving.DocumentSplitCriteria.None" /> for HTML and
- <see cref="F:Aspose.Words.Saving.DocumentSplitCriteria.HeadingParagraph" /> for EPUB.
- </summary>
- <remarks>
- <para>Normally you would want a document saved to HTML as a single file.
- But in some cases it is preferable to split the output into several smaller HTML pages.
- When saving to HTML format these pages will be output to individual files or streams.
- When saving to EPUB format they will be incorporated into corresponding packages.</para>
- <para>A document cannot be split when saving in the MHTML format.</para>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.DocumentSplitHeadingLevel" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.DocumentPartSavingCallback" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.DocumentSplitHeadingLevel">
- <summary>
- Specifies the maximum level of headings at which to split the document.
- Default value is <c>2</c>.
- </summary>
- <remarks>
- <para>When <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.DocumentSplitCriteria" /> includes <see cref="F:Aspose.Words.Saving.DocumentSplitCriteria.HeadingParagraph" />
- and this property is set to a value from 1 to 9, the document will be split at paragraphs formatted using
- <b>Heading 1</b>, <b>Heading 2</b> , <b>Heading 3</b> etc. styles up to the specified heading level.</para>
- <para>By default, only <b>Heading 1</b> and <b>Heading 2</b> paragraphs cause the document to be split.
- Setting this property to zero will cause the document not to be split at heading paragraphs at all.</para>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.DocumentSplitCriteria" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.DocumentPartSavingCallback" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.Encoding">
- <summary>
- Specifies the encoding to use when exporting to HTML, MHTML or EPUB.
- Default value is <c>new UTF8Encoding(false)</c> (UTF-8 without BOM).
- </summary>
- <remarks>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.EpubNavigationMapLevel">
- <summary>
- Specifies the maximum level of headings populated to the navigation map when exporting to IDPF EPUB format.
- Default value is <c>3</c>.
- </summary>
- <remarks>
- <para>Navigation map in IDPF EPUB format allows user agents to provide easy way of navigation
- through the document structure. Usually navigation points correspond to headings in the document.
- To populate headings up to level <b>N</b> assign this value to <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.EpubNavigationMapLevel" />.</para>
- <para>By default, three levels of headings are populated: paragraphs of styles <b>Heading 1</b>, <b>Heading 2</b>
- and <b>Heading 3</b>.
- You can set this property to a value from 1 to 9 to request corresponding maximum level.
- Setting it to zero will reduce navigation map to only document root or roots of document parts.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportDocumentProperties">
- <summary>
- Specifies whether to export built-in and custom document properties to HTML, MHTML or EPUB.
- Default value is <c>false</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportFontResources">
- <summary>
- Specifies whether font resources should be exported to HTML, MHTML or EPUB.
- Default is <c>false</c>.
- </summary>
- <remarks>
- <para>Exporting font resources allows for consistent document rendering independent of the fonts available
- in a given user's environment.</para>
- <para>If <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ExportFontResources" /> is set to <c>true</c>, main HTML document will refer to every font via
- the CSS 3 <b>@font-face</b> at-rule and fonts will be output as separate files. When exporting to IDPF EPUB or MHTML
- formats, fonts will be embedded into the corresponding package along with other subsidiary files.</para>
- <para>If <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ExportFontsAsBase64" /> is set to <c>true</c>, fonts will not be saved to separate files.
- Instead, they will be embedded into <b>@font-face</b> at-rules in Base64 encoding.</para>
- <p>
- <b>Important!</b> When exporting font resources, font licensing issues should be considered. Authors who want to use specific fonts via a downloadable
- font mechanism must always carefully verify that their intended use is within the scope of the font license. Many commercial fonts presently do not
- allow web downloading of their fonts in any form. License agreements that cover some fonts specifically note that usage via <b>@font-face</b> rules
- in CSS style sheets is not allowed. Font subsetting can also violate license terms.
- </p>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontResourcesSubsettingSizeThreshold" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportFontsAsBase64">
- <summary>
- Specifies whether fonts resources should be embedded to HTML in Base64 encoding.
- Default is <c>false</c>.
- </summary>
- <remarks>
- <para>By default, fonts are written to separate files. If this option is set to <c>true</c>, fonts will be embedded
- into the document's CSS in Base64 encoding.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportHeadersFootersMode">
- <summary>
- Specifies how headers and footers are output to HTML, MHTML or EPUB.
- Default value is <see cref="F:Aspose.Words.Saving.ExportHeadersFootersMode.PerSection" /> for HTML/MHTML
- and <see cref="F:Aspose.Words.Saving.ExportHeadersFootersMode.None" /> for EPUB.
- </summary>
- <remarks>
- <para>It is hard to meaningfully output headers and footers to HTML because HTML is not paginated.</para>
- <para>When this property is <see cref="F:Aspose.Words.Saving.ExportHeadersFootersMode.PerSection" />, Aspose.Words exports
- only primary headers and footers at the beginning and the end of each section.</para>
- <para>When it is <see cref="F:Aspose.Words.Saving.ExportHeadersFootersMode.FirstSectionHeaderLastSectionFooter" />
- only first primary header and the last primary footer (including linked to previous) are exported.</para>
- <para>You can disable export of headers and footers altogether by setting this property
- to <see cref="F:Aspose.Words.Saving.ExportHeadersFootersMode.None" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportImagesAsBase64">
- <summary>
- Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
- Default is <c>false</c>.
- </summary>
- <remarks>
- <para>When this property is set to <c>true</c> image data is exported directly on the <b>img</b> elements
- and separate files are not created.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportLanguageInformation">
- <summary>
- Specifies whether language information is exported to HTML, MHTML or EPUB.
- Default is <c>false</c>.
- </summary>
- <remarks>
- <para>When this property is set to <c>true</c> Aspose.Words outputs <b>lang</b> HTML attribute on the document
- elements that specify language. This can be needed to preserve language related semantics.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportListLabels">
- <summary>
- Controls how list labels are output to HTML, MHTML or EPUB.
- Default value is <see cref="F:Aspose.Words.Saving.ExportListLabels.Auto" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.MetafileFormat">
- <summary>
- Specifies in what format metafiles are saved when exporting to HTML, MHTML, or EPUB.
- Default value is <see cref="F:Aspose.Words.Saving.HtmlMetafileFormat.Png" />, meaning that metafiles are rendered to raster PNG images.
- </summary>
- <remarks>
- <para>Metafiles are not natively displayed by HTML browsers. By default, Aspose.Words converts WMF and EMF
- images into PNG files when exporting to HTML. Other options are to convert metafiles to SVG images or to export
- them as is without conversion.</para>
- <para>Some image transforms, in particular image cropping, will not be applied to metafile images if they
- are exported to HTML without conversion.</para>
- </remarks>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImageResolution" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ScaleImageToShapeSize" />
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportPageSetup">
- <summary>
- Specifies whether page setup is exported to HTML, MHTML or EPUB.
- Default is <c>false</c>.
- </summary>
- <remarks>
- <para>Each <see cref="T:Aspose.Words.Section" /> in Aspose.Words document model provides page setup information
- via <see cref="T:Aspose.Words.PageSetup" /> class. When you export a document to HTML format you might need to keep this information
- for further usage. In particular, page setup might be important for rendering to paged media (printing)
- or subsequent conversion to the native Microsoft Word file formats (DOCX, DOC, RTF, WML).</para>
- <para>In most cases HTML is intended for viewing in browsers where pagination is not performed. So this feature
- is inactive by default.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportPageMargins">
- <summary>
- Specifies whether page margins is exported to HTML, MHTML or EPUB.
- Default is <c>false</c>.
- </summary>
- <remarks>
- Aspose.Words does not show area of page margins by default.
- If any elements are completely or partially clipped by the document edge the displayed area can be extended with
- this option.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportRelativeFontSize">
- <summary>
- Specifies whether font sizes should be output in relative units when saving to HTML, MHTML or EPUB.
- Default is <c>false</c>.
- </summary>
- <remarks>
- <para>In many existing documents (HTML, IDPF EPUB) font sizes are specified in relative units. This allows
- applications to adjust text size when viewing/processing documents. For instance, Microsoft Internet Explorer
- has "View->Text Size" submenu, Adobe Digital Editions has two buttons: Increase/Decrease Text Size.
- If you expect this functionality to work then set <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ExportRelativeFontSize" /> property to <c>true</c>.
- </para>
- <para>Aspose Words document model contains and operates only with absolute font size units. Relative units need
- additional logic to be recalculated from some initial (standard) size. Font size of <b>Normal</b> document style
- is taken as standard. For instance, if <b>Normal</b> has 12pt font and some text is 18pt then it will be output
- as <b>1.5em.</b> to the HTML.</para>
- <para>When this option is enabled, document elements other than text will still have absolute sizes. Also some
- text-related attributes might be expressed absolutely. In particular, line spacing specified with "exactly" rule
- might produce unwanted results when scaling text. So the source documents should be properly designed and tested
- when exporting with <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ExportRelativeFontSize" /> set to <c>true</c>.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportTextInputFormFieldAsText">
- <summary>
- Controls how text input form fields are saved to HTML or MHTML.
- Default value is <c>false</c>.
- </summary>
- <remarks>
- <para>When set to <c>true</c>, exports text input form fields as normal text.
- When <c>false</c>, exports Word text input form fields as INPUT elements in HTML.</para>
- <para>When exporting to EPUB, text input form fields are always saved as text due
- to requirements of this format.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportTextBoxAsSvg">
- <summary>
- Controls how textboxes represented by <see cref="T:Aspose.Words.Drawing.Shape" /> are saved to HTML, MHTML or EPUB.
- Default value is <c>false</c>.
- </summary>
- <remarks>
- <para>When set to <c>true</c>, exports textboxes as inline <b><svg></b> elements.
- When <c>false</c>, exports as <b><img></b> elements.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportDropDownFormFieldAsText">
- <summary>
- Controls how drop-down form fields are saved to HTML or MHTML.
- Default value is <c>false</c>.
- </summary>
- <remarks>
- <para>When set to <c>true</c>, exports drop-down form fields as normal text.
- When <c>false</c>, exports drop-down form fields as SELECT element in HTML.</para>
- <para>When exporting to EPUB, text drop-down form fields are always saved as text due
- to requirements of this format.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportTocPageNumbers">
- <summary>
- Specifies whether to write page numbers to table of contents when saving HTML, MHTML and EPUB.
- Default value is <c>false</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportXhtmlTransitional">
- <summary>
- Specifies whether to write the DOCTYPE declaration when saving to HTML or MHTML.
- When <c>true</c>, writes a DOCTYPE declaration in the document prior to the root element.
- Default value is <c>false</c>.
- When saving to EPUB or HTML5 (<see cref="F:Aspose.Words.Saving.HtmlVersion.Html5" />) the DOCTYPE
- declaration is always written.
- </summary>
- <remarks>
- <para>Aspose.Words always writes well formed HTML regardless of this setting.</para>
- <para>When <c>true</c>, the beginning of the HTML output document will look like this:</para>
- <code>
- <?xml version="1.0" encoding="utf-8" standalone="no" ?>
- <!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- </code>
- <para>Aspose.Words aims to output XHTML according to the XHTML 1.0 Transitional specification,
- but the output will not always validate against the DTD. Some structures inside a Microsoft Word
- document are hard or impossible to map to a document that will validate against the XHTML schema.
- For example, XHTML does not allow nested lists (UL cannot be nested inside another UL element),
- but in Microsoft Word document multilevel lists occur quite often.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.HtmlVersion">
- <summary>
- Specifies version of HTML standard that should be used when saving the document to HTML or MHTML.
- Default value is <see cref="F:Aspose.Words.Saving.HtmlVersion.Xhtml" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportRoundtripInformation">
- <summary>
- Specifies whether to write the roundtrip information when saving to HTML, MHTML or EPUB.
- Default value is <c>true</c> for HTML and <c>false</c> for MHTML and EPUB.
- </summary>
- <remarks>
- <para>Saving of the roundtrip information allows to restore document properties such as tab stops,
- comments, headers and footers during the HTML documents loading back into a <see cref="T:Aspose.Words.Document" /> object.</para>
- <para>When <c>true</c>, the roundtrip information is exported as -aw-* CSS properties
- of the corresponding HTML elements.</para>
- <para>When <c>false</c>, causes no roundtrip information to be output into produced files.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolder">
- <summary>
- Specifies a physical folder where all resources like images, fonts, and external CSS are saved when a document
- is exported to HTML. Default is an empty string.
- </summary>
- <remarks>
- <para>
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolder" /> is the simplest way to specify a folder where all resources should be written.
- Another way is to use individual properties <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolder" />, <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder" />,
- and <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.CssStyleSheetFileName" />.</para>
- <para>
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolder" /> has a lower priority than folders specified via <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolder" />,
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder" />, and <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.CssStyleSheetFileName" />. For example, if both
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolder" /> and <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolder" /> are specified, fonts will be saved
- to <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolder" />, while images and CSS will be saved to <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolder" />.</para>
- <para>If the folder specified by <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolder" /> doesn't exist, it will be created automatically.
- </para>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolder" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.CssStyleSheetFileName" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolderAlias">
- <summary>
- Specifies the name of the folder used to construct URIs of all resources written into an HTML document.
- Default is an empty string.
- </summary>
- <remarks>
- <para>
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolderAlias" /> is the simplest way to specify how URIs for all resource files should be
- constructed. Same information can be specified for images and fonts separately via <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolderAlias" />
- and <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolderAlias" /> properties, respectively. However, there is no individual property for CSS.
- </para>
- <para>
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolderAlias" /> has lower priority than <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolderAlias" />
- and <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolderAlias" />. For example, if both <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolderAlias" />
- and <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolderAlias" /> are specified, fonts' URIs will be constructed using
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolderAlias" />, while URIs of images and CSS will be constructed using
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolderAlias" />.</para>
- <para>If <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolderAlias" /> is empty, the <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolder" /> property value will be used
- to construct resource URIs.</para>
- <para>If <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolderAlias" /> is set to '.' (dot), resource URIs will contain file names only, without
- any path.</para>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolder" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolderAlias" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolderAlias" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolder">
- <summary>
- Specifies the physical folder where fonts are saved when exporting a document to HTML.
- Default is an empty string.
- </summary>
- <remarks>
- <para>When you save a <see cref="T:Aspose.Words.Document" /> in HTML format and <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ExportFontResources" />
- is set to <c>true</c>, Aspose.Words needs to save fonts used in the document as standalone files.
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolder" /> allows you to specify where the fonts will be saved and
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolderAlias" /> allows to specify how the font URIs will be constructed.</para>
- <para>If you save a document into a file and provide a file name, Aspose.Words, by default, saves the
- fonts in the same folder where the document file is saved. Use <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolder" />
- to override this behavior.</para>
- <para>If you save a document into a stream, Aspose.Words does not have a folder where to save the fonts,
- but still needs to save the fonts somewhere. In this case, you need to specify an accessible folder
- in the <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolder" /> property or provide custom streams via
- the <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontSavingCallback" /> event handler.</para>
- <para>If the folder specified by <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolder" /> doesn't exist, it will be created automatically.</para>
- <para>
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolder" /> is another way to specify a folder where fonts should be saved.</para>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolder" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ExportFontResources" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolderAlias" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontSavingCallback" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolderAlias">
- <summary>
- Specifies the name of the folder used to construct font URIs written into an HTML document.
- Default is an empty string.
- </summary>
- <remarks>
- <para>When you save a <see cref="T:Aspose.Words.Document" /> in HTML format and <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ExportFontResources" />
- is set to <c>true</c>, Aspose.Words needs to save fonts used in the document as standalone files.
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolder" /> allows you to specify where the fonts will be saved and
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolderAlias" /> allows to specify how the font URIs will be constructed.</para>
- <para>If <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolderAlias" /> is not an empty string, then the font URI written
- to HTML will be <i>FontsFolderAlias + <font file name></i>.</para>
- <para>If <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolderAlias" /> is an empty string, then the font URI written
- to HTML will be <i>FontsFolder + <font file name></i>.</para>
- <para>If <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolderAlias" /> is set to '.' (dot), then the font file name
- will be written to HTML without path regardless of other options.</para>
- <para>Alternative way to specify the name of the folder to construct font URIs
- is to use <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolderAlias" />.</para>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolderAlias" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ExportFontResources" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontsFolder" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontSavingCallback" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.FontResourcesSubsettingSizeThreshold">
- <summary>
- Controls which font resources need subsetting when saving to HTML, MHTML or EPUB.
- Default is <c>0</c>.
- </summary>
- <remarks>
- <para>
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ExportFontResources" /> allows exporting fonts as subsidiary files or as parts of the output
- package. If the document uses many fonts, especially with large number of glyphs, then output size can grow
- significantly. Font subsetting reduces the size of the exported font resource by filtering out glyphs that
- are not used by the current document.</para>
- <para>Font subsetting works as follows:</para>
- <list type="bullet">
- <item>By default, all exported fonts are subsetted.</item>
- <item>Setting <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.FontResourcesSubsettingSizeThreshold" /> to a positive value
- instructs Aspose.Words to subset fonts which file size is larger than the specified value.</item>
- <item>Setting the property to <see cref="F:System.Int32.MaxValue" />
- suppresses font subsetting.</item>
- </list>
- <p>
- <b>Important!</b> When exporting font resources, font licensing issues should be considered. Authors who want to use specific fonts via a downloadable
- font mechanism must always carefully verify that their intended use is within the scope of the font license. Many commercial fonts presently do not
- allow web downloading of their fonts in any form. License agreements that cover some fonts specifically note that usage via <b>@font-face</b> rules
- in CSS style sheets is not allowed. Font subsetting can also violate license terms.
- </p>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ExportFontResources" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.FontSavingCallback">
- <summary>
- Allows to control how fonts are saved when a document is saved to HTML, MHTML or EPUB.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder">
- <summary>
- Specifies the physical folder where images are saved when exporting a document to HTML format.
- Default is an empty string.
- </summary>
- <remarks>
- <para>When you save a <see cref="T:Aspose.Words.Document" /> in HTML format, Aspose.Words needs to save all
- images embedded in the document as standalone files. <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder" />
- allows you to specify where the images will be saved and <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolderAlias" />
- allows to specify how the image URIs will be constructed.</para>
- <para>If you save a document into a file and provide a file name, Aspose.Words, by default, saves the
- images in the same folder where the document file is saved. Use <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder" />
- to override this behavior.</para>
- <para>If you save a document into a stream, Aspose.Words does not have a folder where to save the images,
- but still needs to save the images somewhere. In this case, you need to specify an accessible folder
- in the <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder" /> property or provide custom streams via
- the <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImageSavingCallback" /> event handler.</para>
- <para>If the folder specified by <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder" /> doesn't exist, it will be created automatically.</para>
- <para>
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolder" /> is another way to specify a folder where images should be saved.</para>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolder" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolderAlias" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImageSavingCallback" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolderAlias">
- <summary>
- Specifies the name of the folder used to construct image URIs written into an HTML document.
- Default is an empty string.
- </summary>
- <remarks>
- <para>When you save a <see cref="T:Aspose.Words.Document" /> in HTML format, Aspose.Words needs to save all
- images embedded in the document as standalone files. <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder" />
- allows you to specify where the images will be saved and <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolderAlias" />
- allows to specify how the image URIs will be constructed.</para>
- <para>If <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolderAlias" /> is not an empty string, then the image URI written
- to HTML will be <i>ImagesFolderAlias + <image file name></i>.</para>
- <para>If <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolderAlias" /> is an empty string, then the image URI written
- to HTML will be <i>ImagesFolder + <image file name></i>.</para>
- <para>If <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolderAlias" /> is set to '.' (dot), then the image file name
- will be written to HTML without path regardless of other options.</para>
- <para>Alternative way to specify the name of the folder to construct image URIs
- is to use <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolderAlias" />.</para>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ResourceFolderAlias" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImageSavingCallback" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ImageResolution">
- <summary>
- Specifies the output resolution for images when exporting to HTML, MHTML or EPUB.
- Default is <c>96 dpi</c>.
- </summary>
- <remarks>
- <para>This property effects raster images when <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ScaleImageToShapeSize" />
- is <c>true</c> and effects metafiles exported as raster images. Some image properties such as cropping
- or rotation require saving transformed images and in this case transformed images are created in the given
- resolution.</para>
- </remarks>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ScaleImageToShapeSize" />
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ImageSavingCallback">
- <summary>
- Allows to control how images are saved when a document is saved to HTML, MHTML or EPUB.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ScaleImageToShapeSize">
- <summary>
- Specifies whether images are scaled by Aspose.Words to the bounding shape size when exporting to HTML, MHTML
- or EPUB.
- Default value is <c>true</c>.
- </summary>
- <remarks>
- <para>An image in a Microsoft Word document is a shape. The shape has a size and the image
- has its own size. The sizes are not directly linked. For example, the image can be 1024x786 pixels,
- but shape that displays this image can be 400x300 points.</para>
- <para>In order to display an image in the browser, it must be scaled to the shape size.
- The <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ScaleImageToShapeSize" /> property controls where the scaling of the image
- takes place: in Aspose.Words during export to HTML or in the browser when displaying the document.</para>
- <para>When <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ScaleImageToShapeSize" /> is <c>true</c>, the image is scaled by Aspose.Words
- using high quality scaling during export to HTML. When <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ScaleImageToShapeSize" />
- is <c>false</c>, the image is output with its original size and the browser has to scale it.</para>
- <para>In general, browsers do quick and poor quality scaling. As a result, you will normally get better
- display quality in the browser and smaller file size when <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ScaleImageToShapeSize" /> is <c>true</c>,
- but better printing quality and faster conversion when <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ScaleImageToShapeSize" /> is <c>false</c>.</para>
- </remarks>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImageResolution" />
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.TableWidthOutputMode">
- <summary>
- Controls how table, row and cell widths are exported to HTML, MHTML or EPUB.
- Default value is <see cref="F:Aspose.Words.Saving.HtmlElementSizeOutputMode.All" />.
- </summary>
- <remarks>
- <para>In the HTML format, table, row and cell elements
- (<b><table></b>, <b><tr></b>, <b><th></b>, <b><td></b>)
- can have their widths specified either in relative (percentage) or in absolute units.
- In a document in Aspose.Words, tables, rows and cells can have their widths specified
- using either relative or absolute units too.</para>
- <para>When you convert a document to HTML using Aspose.Words, you might want to control how
- table, row and cell widths are exported to affect how the resulting document is displayed
- in the visual agent (e.g. a browser or viewer).</para>
- <para>Use this property as a filter to specify what table widths values are exported into the destination document.
- For example, if you are converting a document to EPUB and intend to view the document on a mobile reading device,
- then you probably want to avoid exporting absolute width values. To do this you need to specify
- the output mode <see cref="F:Aspose.Words.Saving.HtmlElementSizeOutputMode.RelativeOnly" /> or <see cref="F:Aspose.Words.Saving.HtmlElementSizeOutputMode.None" />
- so the viewer on the mobile device can layout the table to fit the width of the screen as best as it can.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.OfficeMathOutputMode">
- <summary>
- Controls how OfficeMath objects are exported to HTML, MHTML or EPUB.
- Default value is <c>HtmlOfficeMathOutputMode.Image</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportOriginalUrlForLinkedImages">
- <summary>
- Specifies whether original URL should be used as the URL of the linked images.
- Default value is <c>false</c>.
- </summary>
- <remarks>
- <para>If value is set to <c>true</c><see cref="P:Aspose.Words.Drawing.ImageData.SourceFullName" /> value is used
- as the URL of linked images and linked images are not loaded into document's folder
- or <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder" />.</para>
- <para>If value is set to <c>false</c> linked images are loaded into document's folder
- or <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder" /> and URL of each linked image is constructed depending
- on document's folder, <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder" />
- and <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolderAlias" /> properties.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ExportCidUrlsForMhtmlResources">
- <summary>
- Specifies whether to use CID (Content-ID) URLs to reference resources (images, fonts, CSS) included in MHTML
- documents. Default value is <c>false</c>.
- </summary>
- <remarks>
- <para>This option affects only documents being saved to MHTML.</para>
- <para>By default, resources in MHTML documents are referenced by file name (for example, "image.png"), which
- are matched against "Content-Location" headers of MIME parts.</para>
- <para>This option enables an alternative method, where references to resource files are written as CID (Content-ID)
- URLs (for example, "cid:image.png") and are matched against "Content-ID" headers.</para>
- <para>In theory, there should be no difference between the two referencing methods and either of them should work
- fine in any browser or mail agent. In practice, however, some agents fail to fetch resources by file name. If your
- browser or mail agent refuses to load resources included in an MTHML document (doesn't show images or doesn't load
- CSS styles), try exporting the document with CID URLs.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.HtmlSaveOptions.ResolveFontNames">
- <summary>
- Specifies whether font family names used in the document are resolved and substituted according to
- <see cref="P:Aspose.Words.Document.FontSettings" /> when being written into HTML-based formats.
- </summary>
- <remarks>
- <para>By default, this option is set to <c>false</c> and font family names are written to HTML as specified
- in source documents. That is, <see cref="P:Aspose.Words.Document.FontSettings" /> are ignored and no resolution or substitution
- of font family names is performed.</para>
- <para>If this option is set to <c>true</c>, Aspose.Words uses <see cref="P:Aspose.Words.Document.FontSettings" /> to resolve
- each font family name specified in a source document into the name of an available font family, performing
- font subsitution as required.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.IDocumentPartSavingCallback">
- <summary>
- Implement this interface if you want to receive notifications and control how
- Aspose.Words saves document parts when exporting a document to <see cref="F:Aspose.Words.SaveFormat.Html" />
- or <see cref="F:Aspose.Words.SaveFormat.Epub" /> format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.IDocumentPartSavingCallback.DocumentPartSaving(Aspose.Words.Saving.DocumentPartSavingArgs)">
- <summary>
- Called when Aspose.Words is about to save a document part.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.IFontSavingCallback">
- <summary>
- Implement this interface if you want to receive notifications and control how
- Aspose.Words saves fonts when exporting a document to HTML format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.IFontSavingCallback.FontSaving(Aspose.Words.Saving.FontSavingArgs)">
- <summary>
- Called when Aspose.Words is about to save a font resource.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.ImageColorMode">
- <summary>
- Specifies the color mode for the generated images of document pages.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImageColorMode.None">
- <summary>
- The pages of the document will be rendered as color images.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImageColorMode.Grayscale">
- <summary>
- The pages of the document will be rendered as grayscale images.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImageColorMode.BlackAndWhite">
- <summary>
- The pages of the document will be rendered as black and white images.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.ImagePixelFormat">
- <summary>
- Specifies the pixel format for the generated images of document pages.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImagePixelFormat.Format16BppRgb555">
- <summary>
- 16 bits per pixel, RGB.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImagePixelFormat.Format16BppRgb565">
- <summary>
- 16 bits per pixel, RGB.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImagePixelFormat.Format16BppArgb1555">
- <summary>
- 16 bits per pixel, ARGB.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImagePixelFormat.Format24BppRgb">
- <summary>
- 24 bits per pixel, RGB.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImagePixelFormat.Format32BppRgb">
- <summary>
- 32 bits per pixel, RGB.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImagePixelFormat.Format32BppArgb">
- <summary>
- 32 bits per pixel, ARGB.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImagePixelFormat.Format32BppPArgb">
- <summary>
- 32 bits per pixel, ARGB, premultiplied alpha.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImagePixelFormat.Format48BppRgb">
- <summary>
- 48 bits per pixel, RGB.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImagePixelFormat.Format64BppArgb">
- <summary>
- 64 bits per pixel, ARGB.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImagePixelFormat.Format64BppPArgb">
- <summary>
- 64 bits per pixel, ARGB, premultiplied alpha.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.ImagePixelFormat.Format1bppIndexed">
- <summary>
- 1 bit per pixel, Indexed.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.NamespaceDoc">
- <summary>
- <para>The <b>Aspose.Words.Saving</b> namespace provides classes and enumerations that
- allow to specify additional options for saving or converting documents.</para>
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.OdtSaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.Odt" /> or
- <see cref="F:Aspose.Words.SaveFormat.Ott" /> format.
- </summary>
- <remarks>
- <para>At the moment provides only the <see cref="P:Aspose.Words.Saving.OdtSaveOptions.SaveFormat" /> property, but in the future will have
- other options added, such as an encryption password or digital signature settings.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Saving.OdtSaveOptions.#ctor">
- <summary>
- Initializes a new instance of this class that can be used to save a document in the <see cref="F:Aspose.Words.SaveFormat.Odt" /> format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.OdtSaveOptions.#ctor(System.String)">
- <summary>
- Initializes a new instance of this class that can be used to save a document in the <see cref="F:Aspose.Words.SaveFormat.Odt" /> format
- encrypted with a password.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.OdtSaveOptions.#ctor(Aspose.Words.SaveFormat)">
- <summary>
- Initializes a new instance of this class that can be used to save a document in the <see cref="F:Aspose.Words.SaveFormat.Odt" /> or
- <see cref="F:Aspose.Words.SaveFormat.Ott" /> format.
- </summary>
- <param name="saveFormat">Can be <see cref="F:Aspose.Words.SaveFormat.Odt" /> or <see cref="F:Aspose.Words.SaveFormat.Ott" />.</param>
- </member>
- <member name="P:Aspose.Words.Saving.OdtSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can be <see cref="F:Aspose.Words.SaveFormat.Odt" /> or <see cref="F:Aspose.Words.SaveFormat.Ott" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.OdtSaveOptions.IsStrictSchema11">
- <summary>
- Specifies whether export should correspond to ODT specification 1.1 strictly.
- OOo 3.0 displays files correctly when they contain elements and attributes of ODT 1.2.
- Use "false" for this purpose, or "true" for strict conformity of specification 1.1.
- The default value is <b>false</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.OdtSaveOptions.MeasureUnit">
- <summary>
- Allows to specify units of measure to apply to document content.
- The default value is <see cref="F:Aspose.Words.Saving.OdtSaveMeasureUnit.Centimeters" /></summary>
- <remarks>
- Open Office uses centimeters when specifying lengths, widths and other measurable formatting and
- content properties in documents whereas MS Office uses inches.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.OdtSaveOptions.Password">
- <summary>
- Gets or sets a password to encrypt document.
- </summary>
- <remarks>
- <para>In order to save document without encryption this property should be null or empty string.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.OoxmlCompliance">
- <summary>
- Allows to specify which OOXML specification will be used when saving in the DOCX format.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.OoxmlCompliance.Ecma376_2006">
- <summary>
- ECMA-376 1st Edition, 2006.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.OoxmlCompliance.Iso29500_2008_Transitional">
- <summary>
- ISO/IEC 29500:2008 Transitional compliance level.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.OoxmlCompliance.Iso29500_2008_Strict">
- <summary>
- ISO/IEC 29500:2008 Strict compliance level.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.OoxmlSaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.Docx" />,
- <see cref="F:Aspose.Words.SaveFormat.Docm" />, <see cref="F:Aspose.Words.SaveFormat.Dotx" />, <see cref="F:Aspose.Words.SaveFormat.Dotm" /> or
- <see cref="F:Aspose.Words.SaveFormat.FlatOpc" /> format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.OoxmlSaveOptions.#ctor">
- <summary>
- Initializes a new instance of this class that can be used to save a document in the <see cref="F:Aspose.Words.SaveFormat.Docx" /> format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.OoxmlSaveOptions.#ctor(Aspose.Words.SaveFormat)">
- <summary>
- Initializes a new instance of this class that can be used to save a document in the <see cref="F:Aspose.Words.SaveFormat.Docx" />,
- <see cref="F:Aspose.Words.SaveFormat.Docm" />, <see cref="F:Aspose.Words.SaveFormat.Dotx" />, <see cref="F:Aspose.Words.SaveFormat.Dotm" /> or
- <see cref="F:Aspose.Words.SaveFormat.FlatOpc" /> format.
- </summary>
- <param name="saveFormat">Can be <see cref="F:Aspose.Words.SaveFormat.Docx" />, <see cref="F:Aspose.Words.SaveFormat.Docm" />,
- <see cref="F:Aspose.Words.SaveFormat.Dotx" />, <see cref="F:Aspose.Words.SaveFormat.Dotm" /> or <see cref="F:Aspose.Words.SaveFormat.FlatOpc" />.
- </param>
- </member>
- <member name="P:Aspose.Words.Saving.OoxmlSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can be <see cref="F:Aspose.Words.SaveFormat.Docx" />, <see cref="F:Aspose.Words.SaveFormat.Docm" />,
- <see cref="F:Aspose.Words.SaveFormat.Dotx" />, <see cref="F:Aspose.Words.SaveFormat.Dotm" /> or <see cref="F:Aspose.Words.SaveFormat.FlatOpc" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.OoxmlSaveOptions.Password">
- <summary>
- Gets/sets a password to encrypt document using ECMA376 Standard encryption algorithm.
- </summary>
- <remarks>
- <para>In order to save document without encryption this property should be null or empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.OoxmlSaveOptions.Compliance">
- <summary>
- Specifies the OOXML version for the output document.
- The default value is <see cref="F:Aspose.Words.Saving.OoxmlCompliance.Ecma376_2006" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.OoxmlSaveOptions.KeepLegacyControlChars">
- <summary>
- Keeps original representation of legacy control characters.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.OoxmlSaveOptions.CompressionLevel">
- <summary>
- Specifies the compression level used to save document.
- The default value is <see cref="F:Aspose.Words.Saving.CompressionLevel.Normal" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.PdfSaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.Pdf" /> format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.PdfSaveOptions.#ctor">
- <summary>
- Initializes a new instance of this class that can be used to save a document in the
- <see cref="F:Aspose.Words.SaveFormat.Pdf" /> format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.PdfSaveOptions.Clone">
- <summary>
- Creates a deep clone of this object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can only be <see cref="F:Aspose.Words.SaveFormat.Pdf" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.OutlineOptions">
- <summary>
- Allows to specify outline options.
- </summary>
- <remarks>
- <para>Outlines can be created from headings and bookmarks.</para>
- <para>For headings outline level is determined by the heading level.</para>
- <para>It is possible to set the max heading level to be included into outlines or disable heading outlines at all.</para>
- <para>For bookmarks outline level may be set in options as a default value for all bookmarks or as individual values for particular bookmarks.</para>
- <para>Also, outlines can be exported to XPS format by using the same <see cref="P:Aspose.Words.Saving.PdfSaveOptions.OutlineOptions" /> class.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.TextCompression">
- <summary>
- Specifies compression type to be used for all textual content in the document.
- </summary>
- <remarks>
- <para>Default is <see cref="F:Aspose.Words.Saving.PdfTextCompression.Flate" />.</para>
- <para>Significantly increases output size when saving a document without compression.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.JpegQuality">
- <summary>
- Gets or sets a value determining the quality of the JPEG images inside PDF document.
- </summary>
- <remarks>
- <p>The default value is 100.</p>
- <para>This property is used in conjunction with the <see cref="P:Aspose.Words.Saving.PdfSaveOptions.ImageCompression" /> option.</para>
- <para>Has effect only when a document contains JPEG images.</para>
- <para>Use this property to get or set the quality of the images inside a document when saving in PDF format.
- The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100
- means best quality but minimum compression.
- If quality is 100 and source image is JPEG, it means no compression - original bytes will be saved.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.PreserveFormFields">
- <summary>
- Specifies whether to preserve Microsoft Word form fields as form fields in PDF or convert them to text.
- Default is <c>false</c>.
- </summary>
- <remarks>
- <para>Microsoft Word form fields include text input, drop down and check box controls.</para>
- <para>When set to <c>false</c>, these fields will be exported as text to PDF. When set to <c>true</c>, these fields will be exported as PDF form fields.</para>
- <para>When exporting form fields to PDF as form fields, some formatting loss might occur because PDF form fields do not support all features of Microsoft Word form fields.</para>
- <para>Also, the output size depends on the content size because editable forms in Microsoft Word are inline objects.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.CreateNoteHyperlinks">
- <summary>
- Specifies whether to convert footnote/endnote references in main text story into active hyperlinks.
- When clicked the hyperlink will lead to the corresponding footnote/endnote.
- Default is <c>false</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.EncryptionDetails">
- <summary>
- Gets or sets the details for encrypting the output PDF document.
- </summary>
- <remarks>
- <para>The default value is null and the output document will not be encrypted.
- When this property is set to a valid <see cref="T:Aspose.Words.Saving.PdfEncryptionDetails" /> object,
- then the output PDF document will be encrypted.</para>
- <para>Note that encryption cannot be used when PDF/A compliance is set as this compliance does not permit encryption.");</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.DigitalSignatureDetails">
- <summary>
- Gets or sets the details for signing the output PDF document.
- </summary>
- <remarks>
- <para>At the moment digitally signing PDF documents is only available on .NET 2.0 or higher.</para>
- <para>The default value is null and the output document will not be signed.
- When this property is set to a valid <see cref="T:Aspose.Words.Saving.PdfDigitalSignatureDetails" /> object,
- then the output PDF document will be digitally signed.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.EmbedFullFonts">
- <summary>
- Controls how fonts are embedded into the resulting PDF documents.
- </summary>
- <remarks>
- <para> The default value is <c>false</c>, which means the fonts are subsetted before embedding.
- Subsetting is useful if you want to keep the output file size smaller. Subsetting removes all
- unused glyphs from a font.</para>
- <para>When this value is set to <c>true</c>, a complete font file is embedded into PDF without
- subsetting. This will result in larger output files, but can be a useful option when you want to
- edit the resulting PDF later (e.g. add more text).</para>
- <para> Some fonts are large (several megabytes) and embedding them without subsetting
- will result in large output documents.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.FontEmbeddingMode">
- <summary>
- Specifies the font embedding mode.
- </summary>
- <remarks>
- <para>The default value is <see cref="F:Aspose.Words.Saving.PdfFontEmbeddingMode.EmbedAll" />.</para>
- <para>This setting works only for the text in ANSI (Windows-1252) encoding. If the document contains non-ANSI
- text then corresponding fonts will be embedded regardless of this setting.</para>
- <para>Note that when saving to PDF/A this option must be set to <see cref="F:Aspose.Words.Saving.PdfFontEmbeddingMode.EmbedAll" /> as all fonts must be embedded in the PDF file.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.UseCoreFonts">
- <summary>
- Gets or sets a value determining whether or not to substitute TrueType fonts Arial, Times New Roman,
- Courier New and Symbol with core PDF Type 1 fonts.
- </summary>
- <remarks>
- <para>The default value is <c>false</c>. When this value is set to <c>true</c> Arial, Times New Roman,
- Courier New and Symbol fonts are replaced in PDF document with corresponding core Type 1 font.</para>
- <para>Core PDF fonts, or their font metrics and suitable substitution fonts, are required to be available to any
- PDF viewer application.</para>
- <para>This setting works only for the text in ANSI (Windows-1252) encoding. Non-ANSI text will be written
- with embedded TrueType font regardless of this setting.</para>
- <para>Settings core fonts to <c>true</c> is not allowed when saving to PDF/A as this compliance requires all fonts to be embedded.</para>
- <para>This option has a higher priority then <see cref="P:Aspose.Words.Saving.PdfSaveOptions.FontEmbeddingMode" /> option.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.CustomPropertiesExport">
- <summary>
- Gets or sets a value determining the way <see cref="P:Aspose.Words.Document.CustomDocumentProperties" /> are exported to PDF file.
- Default value is <see cref="F:Aspose.Words.Saving.PdfCustomPropertiesExport.None" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.ZoomBehavior">
- <summary>
- Gets or sets a value determining what type of zoom should be applied when a document is opened with a PDF viewer.
- </summary>
- <remarks>
- The default value is <see cref="F:Aspose.Words.Saving.PdfZoomBehavior.None" />, i.e. no fit is applied.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.ZoomFactor">
- <summary>
- Gets or sets a value determining zoom factor (in percentages) for a document.
- </summary>
- <remarks>
- This value is used only if <see cref="P:Aspose.Words.Saving.PdfSaveOptions.ZoomBehavior" /> is set to <see cref="F:Aspose.Words.Saving.PdfZoomBehavior.ZoomFactor" />.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.ImageCompression">
- <summary>
- Specifies compression type to be used for all images in the document.
- </summary>
- <remarks>
- <para>Default is <see cref="F:Aspose.Words.Saving.PdfImageCompression.Auto" />.</para>
- <para>Using <see cref="F:Aspose.Words.Saving.PdfImageCompression.Jpeg" /> lets you control the quality of images in the output document through the <see cref="P:Aspose.Words.Saving.PdfSaveOptions.JpegQuality" /> property.</para>
- <para>Using <see cref="F:Aspose.Words.Saving.PdfImageCompression.Jpeg" /> provides the fastest conversion speed when compared to the performance of other compression types,
- but in this case, there is lossy JPEG compression.</para>
- <para>Using <see cref="F:Aspose.Words.Saving.PdfImageCompression.Auto" /> lets to control the quality of Jpeg in the output document through the <see cref="P:Aspose.Words.Saving.PdfSaveOptions.JpegQuality" /> property,
- but for other formats, raw pixel data is extracted and saved with Flate compression.
- This case is slower than Jpeg conversion but lossless.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.OpenHyperlinksInNewWindow">
- <summary>
- Gets or sets a value determining whether hyperlinks in the output Pdf document
- are forced to be opened in a new window (or tab) of a browser.
- </summary>
- <remarks>
- <para>
- The default value is <c>false</c>. When this value is set to <c>true</c>
- hyperlinks are saved using JavaScript code.
- JavaScript code is <c>app.launchURL("URL", true);</c>,
- where <c>URL</c> is a hyperlink.
- </para>
- <para>
- Note that if this option is set to <c>true</c> hyperlinks can't work
- in some PDF readers e.g. Chrome, Firefox.
- </para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.ExportDocumentStructure">
- <summary>
- Gets or sets a value determining whether or not to export document structure.
- </summary>
- <remarks>
- <para>This value is ignored when saving to PDF/A-1a because document structure is required for this compliance.</para>
- <para>
- Note that exporting the document structure significantly increases the memory consumption, especially
- for the large documents.
- </para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.UseBookFoldPrintingSettings">
- <summary>
- Gets or sets a boolean value indicating whether the document should be saved using a booklet printing layout,
- if it is specified via <see cref="P:Aspose.Words.PageSetup.MultiplePages" />.
- </summary>
- <remarks>
- <para>
- If this option is specified, <see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageSet" />, <see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageIndex" />
- and <see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageCount" /> are ignored when saving.
- This behavior matches MS Word.
- If book fold printing settings are not specified in page setup, this option will have no effect.
- </para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.DownsampleOptions">
- <summary>
- Allows to specify downsample options.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.PageMode">
- <summary>
- Specifies how the PDF document should be displayed when opened in the PDF reader.
- </summary>
- <remarks>
- The default value is <see cref="F:Aspose.Words.Saving.PdfPageMode.UseOutlines" />.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.ImageColorSpaceExportMode">
- <summary>
- Specifies how the color space will be selected for the images in PDF document.
- </summary>
- <remarks>
- The default value is <see cref="F:Aspose.Words.Saving.PdfImageColorSpaceExportMode.Auto" />.
- If <see cref="F:Aspose.Words.Saving.PdfImageColorSpaceExportMode.SimpleCmyk" /> value is specified,
- <see cref="P:Aspose.Words.Saving.PdfSaveOptions.ImageCompression" /> option is ignored and
- Flate compression is used for all images in the document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.PreblendImages">
- <summary>
- Gets or sets a value determining whether or not to preblend transparent images with black background color.
- </summary>
- <remarks>
- <para>Preblending images may improve PDF document visual appearance in Adobe Reader and remove anti-aliasing artifacts.</para>
- <para>In order to properly display preblended images, PDF viewer application must support /Matte entry in soft-mask image dictionary.
- Also preblending images may decrease PDF rendering performance.</para>
- <para>The default value is <c>false</c>.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.DisplayDocTitle">
- <summary>
- A flag specifying whether the window’s title bar should display the document title taken from
- the Title entry of the document information dictionary.
- </summary>
- <remarks>
- If <c>false</c>, the title bar should instead display the name
- of the PDF file containing the document.
-
- <para>The default value is <c>false</c>.</para></remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.DmlEffectsRenderingMode">
- <summary>
- Gets or sets a value determining how DrawingML effects are rendered.
- </summary>
- <remarks>
- The default value is <see cref="F:Aspose.Words.Saving.DmlEffectsRenderingMode.Simplified" />.
- <para>This property is used when the document is exported to fixed page formats.</para><para>If <see cref="P:Aspose.Words.Saving.PdfSaveOptions.Compliance" /> is set to <see cref="F:Aspose.Words.Saving.PdfCompliance.PdfA1a" /> or <see cref="F:Aspose.Words.Saving.PdfCompliance.PdfA1b" />,
- property always returns <see cref="F:Aspose.Words.Saving.DmlEffectsRenderingMode.None" />.</para></remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.EscapeUri">
- <summary>
- A flag specifying whether URI should be escaped before writing.
- </summary>
- <remarks>
- Note that if this option is set to <c>false</c> hyperlinks are written "as is",
- so valid (escaped) URI should be provided in document's model.
- <para>The default value is <c>true</c>.</para></remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.HeaderFooterBookmarksExportMode">
- <summary>
- Determines how bookmarks in headers/footers are exported.
- </summary>
- <remarks>
- <para>The default value is <see cref="F:Aspose.Words.Saving.HeaderFooterBookmarksExportMode.All" />.</para>
- <para>This property is used in conjunction with the <see cref="P:Aspose.Words.Saving.PdfSaveOptions.OutlineOptions" /> option.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.AdditionalTextPositioning">
- <summary>
- A flag specifying whether to write additional text positioning operators or not.
- </summary>
- <remarks>
- <para>
- If <c>true</c>, additional text positioning operators are written to the output PDF. This may help to overcome
- issues with inaccurate text positioning with some printers. The downside is the increased PDF document size.
- </para>
- <para>The default value is <c>false</c>.</para>
- </remarks>
- <dev>
- This option is introduced per enterprise customer request. See WORDSNET-18027 for more details.
- </dev>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.InterpolateImages">
- <summary>
- A flag indicating whether image interpolation shall be performed by a conforming reader.
- When <c>false</c> is specified, the flag is not written to the output document and
- the default behaviour of reader is used instead.
- </summary>
- <remarks>
- <para>
- When the resolution of a source image is significantly lower than that of the output device,
- each source sample covers many device pixels. As a result, images can appear jaggy or blocky.
- These visual artifacts can be reduced by applying an image interpolation algorithm during rendering.
- Instead of painting all pixels covered by a source sample with the same color, image interpolation
- attempts to produce a smooth transition between adjacent sample values.
- </para>
- <para>
- A conforming Reader may choose to not implement this feature of PDF,
- or may use any specific implementation of interpolation that it wishes.
- </para>
- <para>The default value is <c>false</c>.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.PdfSaveOptions.Compliance">
- <summary>
- Specifies the PDF standards compliance level for output documents.
- </summary>
- <remarks>
- <para>Default is <see cref="F:Aspose.Words.Saving.PdfCompliance.Pdf17" />.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.RtfSaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.Rtf" /> format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.RtfSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can only be <see cref="F:Aspose.Words.SaveFormat.Rtf" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.RtfSaveOptions.ExportCompactSize">
- <summary>
- Allows to make output RTF documents smaller in size, but if they contain
- RTL (right-to-left) text, it will not be displayed correctly.
-
- Default value is <c>false</c>.
- </summary>
- <remarks>
- <para>If the document that you want to convert to RTF using Aspose.Words does not contain
- right-to-left text in languages like Arabic, then you can set this option to <c>true</c>
- to reduce the size of the resulting RTF.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.RtfSaveOptions.ExportImagesForOldReaders">
- <summary>
- Specifies whether the keywords for "old readers" are written to RTF or not.
- This can significantly affect the size of the RTF document.
-
- Default value is <c>true</c>.
- </summary>
- <remarks>
- <para>"Old readers" are pre-Microsoft Word 97 applications and also WordPad.
- When this option is <c>true</c> Aspose.Words writes additional RTF keywords.
- These keywords allow the document to be displayed correctly when opened in an
- "old reader" application, but can significantly increase the size of the document.</para>
- <para>If you set this option to <c>false</c>, then only images in WMF, EMF and BMP formats
- will be displayed in "old readers".</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.RtfSaveOptions.SaveImagesAsWmf">
- <summary>
- When true all images will be saved as WMF.
- </summary>
- <remarks>
- This option might help to avoid WordPad warning messages.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.SaveOptions">
- <summary>
- This is an abstract base class for classes that allow the user to specify additional
- options when saving a document into a particular format.
- </summary>
- <remarks>
- An instance of the SaveOptions class or any derived class is passed to the stream <see cref="M:Aspose.Words.Document.Save(System.IO.Stream,Aspose.Words.Saving.SaveOptions)" />
- or string <see cref="M:Aspose.Words.Document.Save(System.String,Aspose.Words.Saving.SaveOptions)" /> overloads for the user to define custom options when saving a document.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Saving.SaveOptions.CreateSaveOptions(Aspose.Words.SaveFormat)">
- <overloads>Creates a save options object of a correct class.</overloads>
- <summary>
- Creates a save options object of a class suitable for the specified save format.
- </summary>
- <param name="saveFormat">The save format for which to create a save options object.</param>
- <returns>An object of a class that derives from <see cref="T:Aspose.Words.Saving.SaveOptions" />.</returns>
- </member>
- <member name="M:Aspose.Words.Saving.SaveOptions.CreateSaveOptions(System.String)">
- <summary>
- Creates a save options object of a class suitable for the file extension specified in the given file name.
- </summary>
- <param name="fileName">The extension of this file name determines the class of the save options object to create.</param>
- <returns>An object of a class that derives from <see cref="T:Aspose.Words.Saving.SaveOptions" />.</returns>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOptions.TempFolder">
- <summary>
- Specifies the folder for temporary files used when saving to a DOC or DOCX file.
- By default this property is <c>null</c> and no temporary files are used.
- </summary>
- <remarks>
- <para>When Aspose.Words saves a document, it needs to create temporary internal structures. By default,
- these internal structures are created in memory and the memory usage spikes for a short period while
- the document is being saved. When saving is complete, the memory is freed and reclaimed by the garbage collector.</para>
- <para>If you are saving a very large document (thousands of pages) and/or processing many documents at the same time,
- then the memory spike during saving can be significant enough to cause the system to throw <see cref="T:System.OutOfMemoryException" />.
- Specifying a temporary folder using <see cref="P:Aspose.Words.Saving.SaveOptions.TempFolder" /> will cause Aspose.Words to keep the internal structures in
- temporary files instead of memory. It reduces the memory usage during saving, but will decrease the save performance.</para>
- <para>The folder must exist and be writable, otherwise an exception will be thrown.</para>
- <para>Aspose.Words automatically deletes all temporary files when saving is complete.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOptions.PrettyFormat">
- <summary>
- When <c>true</c>, pretty formats output where applicable.
- Default value is <b>false</b>.
- </summary>
- <remarks>
- <p>Set to <b>true</b> to make HTML, MHTML, EPUB, WordML, RTF, DOCX and ODT output human readable.
- Useful for testing or debugging.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOptions.UseAntiAliasing">
- <summary>
- Gets or sets a value determining whether or not to use anti-aliasing for rendering.
- </summary>
- <remarks>
- <para>
- The default value is <c>false</c>. When this value is set to <c>true</c> anti-aliasing is
- used for rendering.
- </para>
- <para>This property is used when the document is exported to the following formats:
- <see cref="F:Aspose.Words.SaveFormat.Tiff" />, <see cref="F:Aspose.Words.SaveFormat.Png" />, <see cref="F:Aspose.Words.SaveFormat.Bmp" />,
- <see cref="F:Aspose.Words.SaveFormat.Jpeg" />, <see cref="F:Aspose.Words.SaveFormat.Emf" />. When the document is exported to the
- <see cref="F:Aspose.Words.SaveFormat.Html" />, <see cref="F:Aspose.Words.SaveFormat.Mhtml" /> and <see cref="F:Aspose.Words.SaveFormat.Epub" />
- formats this option is used for raster images.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOptions.UseHighQualityRendering">
- <summary>
- Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
- </summary>
- <remarks>
- The default value is <c>false</c>.
- <para>This property is used when the document is exported to image formats:
- <see cref="F:Aspose.Words.SaveFormat.Tiff" />, <see cref="F:Aspose.Words.SaveFormat.Png" />, <see cref="F:Aspose.Words.SaveFormat.Bmp" />,
- <see cref="F:Aspose.Words.SaveFormat.Jpeg" />, <see cref="F:Aspose.Words.SaveFormat.Emf" />.</para></remarks>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOptions.UpdateSdtContent">
- <summary>
- Gets or sets value determining whether content of <see cref="T:Aspose.Words.Markup.StructuredDocumentTag" /> is updated before saving.
- </summary>
- <remarks>
- The default value is <c>true</c>.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOptions.DmlRenderingMode">
- <summary>
- Gets or sets a value determining how DrawingML shapes are rendered.
- </summary>
- <remarks>
- The default value is <see cref="F:Aspose.Words.Saving.DmlRenderingMode.Fallback" />.
- <para>This property is used when the document is exported to fixed page formats.</para></remarks>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOptions.DmlEffectsRenderingMode">
- <summary>
- Gets or sets a value determining how DrawingML effects are rendered.
- </summary>
- <remarks>
- The default value is <see cref="F:Aspose.Words.Saving.DmlEffectsRenderingMode.Simplified" />.
- <para>This property is used when the document is exported to fixed page formats.</para></remarks>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOptions.DefaultTemplate">
- <summary>
- Gets or sets path to default template (including filename).
- Default value for this property is <b>empty string</b> (<see cref="F:System.String.Empty" />).
- </summary>
- <remarks>If specified, this path is used to load template when <see cref="P:Aspose.Words.Document.AutomaticallyUpdateStyles" /> is true,
- but <see cref="P:Aspose.Words.Document.AttachedTemplate" /> is empty.</remarks>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOptions.UpdateFields">
- <summary>
- Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format.
- Default value for this property is <b>true</b>.
- </summary>
- <remarks>
- Allows to specify whether to mimic or not MS Word behavior.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOptions.UpdateLastSavedTimeProperty">
- <summary>
- Gets or sets a value determining whether the <see cref="P:Aspose.Words.Properties.BuiltInDocumentProperties.LastSavedTime" /> property is updated before saving.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOptions.UpdateLastPrintedProperty">
- <summary>
- Gets or sets a value determining whether the <see cref="P:Aspose.Words.Properties.BuiltInDocumentProperties.LastPrinted" /> property is updated before saving.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOptions.MemoryOptimization">
- <summary>
- Gets or sets value determining if memory optimization should be performed before saving the document.
- Default value for this property is <b>false</b>.
- </summary>
- <remarks>
- Setting this option to true can significantly decrease memory consumption while saving large documents at the cost of slower saving time.
- </remarks>
- <dev>
- So far only attribute interning procedure is bound to this property but I think we can make more memory optimization in the future.
- That's why I decided to use more general property name.
- </dev>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOptions.Dml3DEffectsRenderingMode">
- <summary>
- Gets or sets a value determining how 3D effects are rendered.
- </summary>
- <remarks>
- The default value is <see cref="F:Aspose.Words.Saving.Dml3DEffectsRenderingMode.Basic" />.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.TxtSaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.Text" /> format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.TxtSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can only be <see cref="F:Aspose.Words.SaveFormat.Text" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.TxtSaveOptions.SimplifyListLabels">
- <summary>
- <para>Specifies whether the program should simplify list labels in case of
- complex label formatting not being adequately represented by plain text.</para>
- <para>If set to <b>true</b>, numbered list labels are written in simple numeric format
- and itemized list labels as simple ASCII characters. The default value is <b>false</b>.</para>
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.TxtSaveOptions.AddBidiMarks">
- <summary>
- <para>Specifies whether to add bi-directional marks before each BiDi run when exporting in plain text format.</para>
- <para>The default value is <b>false</b>.</para>
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.TxtSaveOptions.ListIndentation">
- <summary>
- Gets a ListIndentation object that specifies how many and which character to use for indentation of list levels.
- By default it is zero count of character '\0', that means no indentation.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.TxtSaveOptions.PreserveTableLayout">
- <summary>
- Specifies whether the program should attempt to preserve layout of tables when saving in the plain text format.
- The default value is <b>false</b>.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.WordML2003SaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.WordML" /> format.
- </summary>
- <remarks>
- <para>At the moment provides only the <see cref="P:Aspose.Words.Saving.WordML2003SaveOptions.SaveFormat" /> property, but in the future may have other options added.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.WordML2003SaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can only be <see cref="F:Aspose.Words.SaveFormat.WordML" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.XamlFlowSaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the
- <see cref="F:Aspose.Words.SaveFormat.XamlFlow" /> or <see cref="F:Aspose.Words.SaveFormat.XamlFlowPack" /> format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.XamlFlowSaveOptions.#ctor">
- <summary>
- Initializes a new instance of this class that can be used to save a document in the <see cref="F:Aspose.Words.SaveFormat.XamlFlow" /> format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.XamlFlowSaveOptions.#ctor(Aspose.Words.SaveFormat)">
- <summary>
- Initializes a new instance of this class that can be used to save a document in the <see cref="F:Aspose.Words.SaveFormat.XamlFlow" />
- or <see cref="F:Aspose.Words.SaveFormat.XamlFlowPack" /> format.
- </summary>
- <param name="saveFormat">Can be <see cref="F:Aspose.Words.SaveFormat.XamlFlow" /> or <see cref="F:Aspose.Words.SaveFormat.XamlFlowPack" />.</param>
- </member>
- <member name="P:Aspose.Words.Saving.XamlFlowSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can only be <see cref="F:Aspose.Words.SaveFormat.XamlFlow" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolder">
- <summary>
- Specifies the physical folder where images are saved when exporting a document to XAML format.
- Default is an empty string.
- </summary>
- <remarks>
- <p>When you save a <see cref="T:Aspose.Words.Document" /> in XAML format, Aspose.Words needs to save all
- images embedded in the document as standalone files. <see cref="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolder" />
- allows you to specify where the images will be saved and <see cref="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolderAlias" />
- allows to specify how the image URIs will be constructed.</p>
- <p>If you save a document into a file and provide a file name, Aspose.Words, by default, saves the
- images in the same folder where the document file is saved. Use <see cref="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolder" />
- to override this behavior.</p>
- <p>If you save a document into a stream, Aspose.Words does not have a folder where to save the images,
- but still needs to save the images somewhere. In this case, you need to specify an accessible folder
- in the <see cref="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolder" /> property or provide custom streams via
- the <see cref="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImageSavingCallback" /> event handler.</p>
- <seealso cref="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolderAlias" />
- <seealso cref="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImageSavingCallback" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolderAlias">
- <summary>
- Specifies the name of the folder used to construct image URIs written into an XAML document.
- Default is an empty string.
- </summary>
- <remarks>
- <p>When you save a <see cref="T:Aspose.Words.Document" /> in XAML format, Aspose.Words needs to save all
- images embedded in the document as standalone files. <see cref="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolder" />
- allows you to specify where the images will be saved and <see cref="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolderAlias" />
- allows to specify how the image URIs will be constructed.</p>
- <p>If <see cref="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolderAlias" /> is not an empty string, then the image URI written
- to XAML will be <i>ImagesFolderAlias + <image file name></i>.</p>
- <p>If <see cref="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolderAlias" /> is an empty string, then the image URI written
- to XAML will be <i>ImagesFolder + <image file name></i>.</p>
- <p>If <see cref="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolderAlias" /> is set to '.' (dot), then the image file name
- will be written to XAML without path regardless of other options.</p>
- <seealso cref="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImagesFolder" />
- <seealso cref="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImageSavingCallback" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.XamlFlowSaveOptions.ImageSavingCallback">
- <summary>
- Allows to control how images are saved when a document is saved to XAML.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.XpsSaveOptions">
- <summary>
- Can be used to specify additional options when saving a document into the <see cref="F:Aspose.Words.SaveFormat.Xps" /> format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.XpsSaveOptions.#ctor">
- <summary>
- Initializes a new instance of this class that can be used to save a document
- in the <see cref="F:Aspose.Words.SaveFormat.Xps" /> format.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.XpsSaveOptions.#ctor(Aspose.Words.SaveFormat)">
- <summary>
- Initializes a new instance of this class that can be used to save a document
- in the <see cref="F:Aspose.Words.SaveFormat.Xps" /> or <see cref="F:Aspose.Words.SaveFormat.OpenXps" /> format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.XpsSaveOptions.SaveFormat">
- <summary>
- Specifies the format in which the document will be saved if this save options object is used.
- Can only be <see cref="F:Aspose.Words.SaveFormat.Xps" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.XpsSaveOptions.OutlineOptions">
- <summary>
- Allows to specify outline options.
- </summary>
- <remarks>
- <para>Note that ExpandedOutlineLevels option will not work when saving to XPS.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.XpsSaveOptions.UseBookFoldPrintingSettings">
- <summary>
- Gets or sets a boolean value indicating whether the document should be saved using a booklet printing layout,
- if it is specified via <see cref="P:Aspose.Words.PageSetup.MultiplePages" />.
- </summary>
- <remarks>
- <para>
- If this option is specified, <see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageSet" />, <see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageIndex" />
- and <see cref="P:Aspose.Words.Saving.FixedPageSaveOptions.PageCount" /> are ignored when saving.
- This behavior matches MS Word.
- If book fold printing settings are not specified in page setup, this option will have no effect.
- </para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.SaveOutputParameters">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.SaveOutputParameters.ContentType">
- <summary>
- Returns the Content-Type string (Internet Media Type) that identifies the type of the saved document.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.CssStyleSheetType">
- <summary>
- Specifies how CSS (Cascading Style Sheet) styles are exported to HTML.
- </summary>
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.CssStyleSheetType" />
- </member>
- <member name="F:Aspose.Words.Saving.CssStyleSheetType.Inline">
- <summary>
- CSS styles are written inline (as a value of the <b>style</b> attribute on every element).
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.CssStyleSheetType.Embedded">
- <summary>
- CSS styles are written separately from the content in a style sheet embedded in the HTML file.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.CssStyleSheetType.External">
- <summary>
- CSS styles are written separately from the content in a style sheet in an external file.
- The HTML file links the style sheet.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.ImageSavingArgs">
- <summary>
- Provides data for the <see cref="M:Aspose.Words.Saving.IImageSavingCallback.ImageSaving(Aspose.Words.Saving.ImageSavingArgs)" /> event.
- </summary>
- <remarks>
- <para>By default, when Aspose.Words saves a document to HTML, it saves each image into
- a separate file. Aspose.Words uses the document file name and a unique number to generate unique file name
- for each image found in the document.</para>
- <para>
- <see cref="T:Aspose.Words.Saving.ImageSavingArgs" /> allows to redefine how image file names are generated or to
- completely circumvent saving of images into files by providing your own stream objects.</para>
- <para>To apply your own logic for generating image file names use the
- <see cref="P:Aspose.Words.Saving.ImageSavingArgs.ImageFileName" />, <see cref="P:Aspose.Words.Saving.ImageSavingArgs.CurrentShape" /> and <see cref="P:Aspose.Words.Saving.ImageSavingArgs.IsImageAvailable" />
- properties.</para>
- <para>To save images into streams instead of files, use the <see cref="P:Aspose.Words.Saving.ImageSavingArgs.ImageStream" /> property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSavingArgs.Document">
- <summary>
- Gets the document object that is currently being saved.
- </summary>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSavingArgs.CurrentShape">
- <summary>
- Gets the <see cref="T:Aspose.Words.Drawing.ShapeBase" /> object corresponding to the shape or group shape
- that is about to be saved.
- </summary>
- <remarks>
- <para>
- <see cref="T:Aspose.Words.Saving.IImageSavingCallback" /> can be fired while saving either a shape or a group shape.
- That's why the property has <see cref="T:Aspose.Words.Drawing.ShapeBase" /> type. You can check whether it's a group shape comparing
- <see cref="P:Aspose.Words.Drawing.ShapeBase.ShapeType" /> with <see cref="F:Aspose.Words.Drawing.ShapeType.Group" /> or by casting it to one of derived classes:
- <see cref="T:Aspose.Words.Drawing.Shape" /> or <see cref="T:Aspose.Words.Drawing.GroupShape" />.</para>
- <para>Aspose.Words uses the document file name and a unique number to generate unique file name
- for each image found in the document. You can use the <see cref="P:Aspose.Words.Saving.ImageSavingArgs.CurrentShape" /> property to generate
- a "better" file name by examining shape properties such as <see cref="P:Aspose.Words.Drawing.ImageData.Title" />
- (Shape only), <see cref="P:Aspose.Words.Drawing.ImageData.SourceFullName" /> (Shape only)
- and <see cref="P:Aspose.Words.Drawing.ShapeBase.Name" />. Of course you can build file names using any other properties or criteria
- but note that subsidiary file names must be unique within the export operation.</para>
- <para>Some images in the document can be unavailable. To check image availability
- use the <see cref="P:Aspose.Words.Saving.ImageSavingArgs.IsImageAvailable" /> property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSavingArgs.IsImageAvailable">
- <summary>
- Returns <c>true</c> if the current image is available for export.
- </summary>
- <remarks>
- <para>Some images in the document can be unavailable, for example, because the image
- is linked and the link is inaccessible or does not point to a valid image.
- In this case Aspose.Words exports an icon with a red cross. This property returns
- <c>true</c> if the original image is available; returns <c>false</c> if the original
- image is not available and a "no image" icon will be offered for save.</para>
- <para>When saving a group shape or a shape that doesn't require any image this property
- is always <c>true</c>.</para>
- </remarks>
- <seealso cref="P:Aspose.Words.Saving.ImageSavingArgs.CurrentShape" />
- </member>
- <member name="P:Aspose.Words.Saving.ImageSavingArgs.ImageFileName">
- <summary>
- Gets or sets the file name (without path) where the image will be saved to.
- </summary>
- <remarks>
- <para>This property allows you to redefine how the image file names are generated
- during export to HTML.</para>
- <para>When the event is fired, this property contains the file name that was generated
- by Aspose.Words. You can change the value of this property to save the image into a
- different file. Note that file names must be unique.</para>
- <p>Aspose.Words automatically generates a unique file name for every embedded image when
- exporting to HTML format. How the image file name is generated
- depends on whether you save the document to a file or to a stream.</p>
- <p>When saving a document to a file, the generated image file name looks like
- <i><document base file name>.<image number>.<extension></i>.</p>
- <p>When saving a document to a stream, the generated image file name looks like
- <i>Aspose.Words.<document guid>.<image number>.<extension></i>.</p>
- <para>
- <see cref="P:Aspose.Words.Saving.ImageSavingArgs.ImageFileName" /> must contain only the file name without the path.
- Aspose.Words determines the path for saving and the value of the <c>src</c> attribute for writing
- to HTML using the document file name, the <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder" /> and
- <see cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolderAlias" /> properties.</para>
- <seealso cref="P:Aspose.Words.Saving.ImageSavingArgs.CurrentShape" />
- <seealso cref="P:Aspose.Words.Saving.ImageSavingArgs.IsImageAvailable" />
- <seealso cref="P:Aspose.Words.Saving.ImageSavingArgs.ImageStream" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolder" />
- <seealso cref="P:Aspose.Words.Saving.HtmlSaveOptions.ImagesFolderAlias" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSavingArgs.KeepImageStreamOpen">
- <summary>
- Specifies whether Aspose.Words should keep the stream open or close it after saving an image.
- </summary>
- <remarks>
- <para>Default is <c>false</c> and Aspose.Words will close the stream you provided
- in the <see cref="P:Aspose.Words.Saving.ImageSavingArgs.ImageStream" /> property after writing an image into it.
- Specify <c>true</c> to keep the stream open.</para>
- <seealso cref="P:Aspose.Words.Saving.ImageSavingArgs.ImageStream" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Saving.ImageSavingArgs.ImageStream">
- <summary>
- Allows to specify the stream where the image will be saved to.
- </summary>
- <remarks>
- <para>This property allows you to save images to streams instead of files during HTML.</para>
- <para>The default value is <c>null</c>. When this property is <c>null</c>, the image
- will be saved to a file specified in the <see cref="P:Aspose.Words.Saving.ImageSavingArgs.ImageFileName" /> property.</para>
- <para>Using <see cref="T:Aspose.Words.Saving.IImageSavingCallback" /> you cannot substitute one image with
- another. It is intended only for control over location where to save images.</para>
- <seealso cref="P:Aspose.Words.Saving.ImageSavingArgs.ImageFileName" />
- <seealso cref="P:Aspose.Words.Saving.ImageSavingArgs.KeepImageStreamOpen" />
- </remarks>
- </member>
- <member name="T:Aspose.Words.Saving.IImageSavingCallback">
- <summary>
- 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.
- </summary>
- </member>
- <member name="M:Aspose.Words.Saving.IImageSavingCallback.ImageSaving(Aspose.Words.Saving.ImageSavingArgs)">
- <summary>
- Called when Aspose.Words saves an image to HTML.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.PdfCompliance">
- <summary>
- Specifies the PDF standards compliance level.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfCompliance.Pdf17">
- <summary>
- The output file will comply with the PDF 1.7 standard.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfCompliance.Pdf15">
- <summary>
- The output file will comply with the PDF 1.5 standard.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfCompliance.PdfA1a">
- <summary>
- The output file will comply with the PDF/A-1a standard.
- This level includes all the requirements of PDF/A-1b and additionally requires
- that document structure be included (also known as being "tagged"),
- with the objective of ensuring that document content can be searched and repurposed.
- </summary>
- <remarks>
- Note that exporting the document structure significantly increases the memory consumption, especially
- for the large documents.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Saving.PdfCompliance.PdfA1b">
- <summary>
- The output file will comply with the PDF/A-1b standard.
- PDF/A-1b has the objective of ensuring reliable reproduction of the
- visual appearance of the document.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.PdfTextCompression">
- <summary>
- Specifies a type of compression applied to all content in the PDF file except images.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfTextCompression.None">
- <summary>
- No compression.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.PdfTextCompression.Flate">
- <summary>
- Flate (ZIP) compression.
- </summary>
- </member>
- <member name="T:Aspose.Words.Saving.TiffCompression">
- <summary>
- Specifies what type of compression to apply when saving page images into a TIFF file.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.TiffCompression.None">
- <summary>
- Specifies no compression.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.TiffCompression.Rle">
- <summary>
- Specifies the RLE compression scheme.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.TiffCompression.Lzw">
- <summary>
- Specifies the LZW compression scheme.
- In Java emulated by Deflate (Zip) compression.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.TiffCompression.Ccitt3">
- <summary>
- Specifies the CCITT3 compression scheme.
- </summary>
- </member>
- <member name="F:Aspose.Words.Saving.TiffCompression.Ccitt4">
- <summary>
- Specifies the CCITT4 compression scheme.
- </summary>
- </member>
- <member name="T:Aspose.Words.Markup.StructuredDocumentTagRangeStart">
- <summary>
- Represents a start of <b>ranged</b> structured document tag which accepts multi-sections content.
- See also <see cref="T:Aspose.Words.Markup.StructuredDocumentTagRangeEnd" />.
- </summary>
- <remarks>
- Can be immediate child of <see cref="T:Aspose.Words.Body" /> node <b>only</b>.
- </remarks>
- <dev>Implements public facade for encapsulated StructuredDocumentTag node.</dev>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTagRangeStart.Level">
- <summary>
- Gets the level at which this <b>SDT range start</b> occurs in the document tree.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTagRangeStart.SdtType">
- <summary>
- Gets type of this <b>Structured document tag</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTagRangeStart.Id">
- <summary>
- <para>Specifies a unique read-only persistent numerical Id for this <b>SDT</b>.</para>
- </summary>
- <remarks>
- <para> Id attribute shall follow these rules:
- <list type="bullet"><item>The document shall retain SDT ids only if the whole document is cloned <see cref="M:Aspose.Words.Document.Clone" />.</item><item>During <see cref="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean)" />
- Id shall be retained if import does not cause conflicts with other SDT Ids in
- the target document.</item><item>
- If multiple SDT nodes specify the same decimal number value for the Id attribute,
- then the first SDT in the document shall maintain this original Id,
- and all subsequent SDT nodes shall have new identifiers assigned to them when the document is loaded.
- </item><item>During standalone SDT <see cref="M:Aspose.Words.Markup.StructuredDocumentTag.Clone(System.Boolean,Aspose.Words.INodeCloningListener)" /> operation new unique ID will be generated for the cloned SDT node.</item><item>
- If Id is not specified in the source document, then the SDT node shall have a new unique identifier assigned
- to it when the document is loaded.
- </item></list></para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTagRangeStart.LockContentControl">
- <summary>
- When set to true, this property will prohibit a user from deleting this <b>SDT</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTagRangeStart.LockContents">
- <summary>
- When set to true, this property will prohibit a user from editing the contents of this <b>SDT</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTagRangeStart.IsShowingPlaceholderText">
- <summary>
- <para>
- Specifies whether the content of this <b>SDT</b> shall be interpreted to contain placeholder text
- (as opposed to regular text contents within the SDT).
- </para>
- <para>
- if set to true, this state shall be resumed (showing placeholder text) upon opening this document.
- </para>
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTagRangeStart.Tag">
- <summary>
- Specifies a tag associated with the current SDT node.
- Can not be null.
- </summary>
- <remarks> A tag is an arbitrary string which applications can associate with SDT
- in order to identify it without providing a visible friendly name.</remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTagRangeStart.Title">
- <summary>
- Specifies the friendly name associated with this <b>SDT</b>.
- Can not be null.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTagRangeStart.XmlMapping">
- <summary>
- Gets an object that represents the mapping of this structured document tag range to XML data
- in a custom XML part of the current document.
- </summary>
- <remarks>
- You can use the <see cref="M:Aspose.Words.Markup.XmlMapping.SetMapping(Aspose.Words.Markup.CustomXmlPart,System.String,System.String)" /> method of this
- object to map a structured document tag range to XML data.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTagRangeStart.RangeEnd">
- <summary>
- Specifies end of range if the StructuredDocumentTag is a ranged structured document tag.
- Otherwise returns null.
- </summary>
- </member>
- <member name="T:Aspose.Words.Markup.StructuredDocumentTagRangeEnd">
- <summary>
- Represents an end of <b>ranged</b> structured document tag which accepts multi-sections content.
- See also <see cref="T:Aspose.Words.Markup.StructuredDocumentTagRangeStart" /> node.
- </summary>
- <remarks>
- Can be immediate child of <see cref="T:Aspose.Words.Body" /> node <b>only</b>.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTagRangeEnd.Id">
- <summary>
- Specifies a unique read-only persistent numerical Id for this <b>StructuredDocumentTagRange</b> node.
- Corresponding <see cref="T:Aspose.Words.Markup.StructuredDocumentTagRangeStart" /> node has the same <see cref="P:Aspose.Words.Markup.StructuredDocumentTagRangeStart.Id" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Markup.CustomXmlSchemaCollection">
- <summary>
- A collection of strings that represent XML schemas that are associated with a custom XML part.
- </summary>
- <remarks>
- <para>You do not create instances of this class. You access the collection of XML schemas of a custom XML part
- via the <see cref="P:Aspose.Words.Markup.CustomXmlPart.Schemas" /> property.</para>
- <seealso cref="T:Aspose.Words.Markup.CustomXmlPart" />
- <seealso cref="P:Aspose.Words.Markup.CustomXmlPart.Schemas" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlSchemaCollection.GetEnumerator">
- <summary>
- Returns an enumerator object that can be used to iterate over all items in the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlSchemaCollection.Add(System.String)">
- <summary>
- Adds an item to the collection.
- </summary>
- <param name="value">The item to add.</param>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlSchemaCollection.IndexOf(System.String)">
- <summary>
- Returns the zero-based index of the specified value in the collection.
- </summary>
- <param name="value">The case-sensitive value to locate.</param>
- <returns>The zero based index. Negative value if not found.</returns>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlSchemaCollection.Remove(System.String)">
- <summary>
- Removes the specified value from the collection.
- </summary>
- <param name="name">The case-sensitive value to remove.</param>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlSchemaCollection.RemoveAt(System.Int32)">
- <summary>
- Removes a value at the specified index.
- </summary>
- <param name="index">The zero based index.</param>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlSchemaCollection.Clear">
- <summary>
- Removes all elements from the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlSchemaCollection.Clone">
- <summary>
- Makes a deep clone of this object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.CustomXmlSchemaCollection.Count">
- <summary>
- Gets the number of elements contained in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.CustomXmlSchemaCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- </member>
- <member name="T:Aspose.Words.Markup.SdtDateStorageFormat">
- <summary>
- 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.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtDateStorageFormat.Date">
- <summary>
- The date value for a date SDT is stored as a date in the standard XML Schema Date format.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtDateStorageFormat.DateTime">
- <summary>
- The date value for a date SDT is stored as a date in the standard XML Schema DateTime format.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtDateStorageFormat.Text">
- <summary>
- The date value for a date SDT is stored as text.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtDateStorageFormat.Default">
- <summary>
- Defaults to <see cref="F:Aspose.Words.Markup.SdtDateStorageFormat.DateTime" /></summary>
- </member>
- <member name="T:Aspose.Words.Markup.SdtListItemCollection">
- <summary>
- Provides access to <see cref="T:Aspose.Words.Markup.SdtListItem" /> elements of a structured document tag.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.SdtListItemCollection.GetEnumerator">
- <summary>
- Returns an enumerator object that can be used to iterate over all items in the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.SdtListItemCollection.Add(Aspose.Words.Markup.SdtListItem)">
- <summary>
- Adds an item to this collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.SdtListItemCollection.RemoveAt(System.Int32)">
- <summary>
- Removes a list item at the specified index.
- </summary>
- <param name="index">The zero-based index of the item to remove.</param>
- </member>
- <member name="M:Aspose.Words.Markup.SdtListItemCollection.Clear">
- <summary>
- Clears all items from this collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.SdtListItemCollection.SelectedValue">
- <summary>
- Specifies currently selected value in this list.
- Null value allowed, meaning that no currently selected entry is associated with this list item collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.SdtListItemCollection.Item(System.Int32)">
- <summary>
- Returns a <see cref="T:Aspose.Words.Markup.SdtListItem" /> object given its zero-based index in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.SdtListItemCollection.Count">
- <summary>
- Gets number of items in the collection.
- </summary>
- </member>
- <member name="T:Aspose.Words.Markup.StructuredDocumentTag">
- <summary>
- Represents a structured document tag (SDT or content control) in a document.
- </summary>
- <remarks>
- <para>Structured document tags (SDTs) allow to embed customer-defined semantics as well as its
- behavior and appearance into a document.</para>
- <para>In this version Aspose.Words provides a number of public methods and properties to
- manipulate the behavior and content of <see cref="T:Aspose.Words.Markup.StructuredDocumentTag" />.
- Mapping of SDT nodes to custom XML packages within a document can be performed with using
- the <see cref="P:Aspose.Words.Markup.StructuredDocumentTag.XmlMapping" /> property.</para>
- <para>
- <see cref="T:Aspose.Words.Markup.StructuredDocumentTag" /> can occur in a document in the following places:</para>
- <list type="bullet">
- <item>Block-level - Among paragraphs and tables, as a child of a <see cref="T:Aspose.Words.Body" />, <see cref="T:Aspose.Words.HeaderFooter" />,
- <see cref="T:Aspose.Words.Comment" />, <see cref="T:Aspose.Words.Footnote" /> or a <see cref="T:Aspose.Words.Drawing.Shape" /> node.</item>
- <item>Row-level - Among rows in a table, as a child of a <see cref="T:Aspose.Words.Tables.Table" /> node.</item>
- <item>Cell-level - Among cells in a table row, as a child of a <see cref="T:Aspose.Words.Tables.Row" /> node.</item>
- <item>Inline-level - Among inline content inside, as a child of a <see cref="T:Aspose.Words.Paragraph" />.</item>
- <item>Nested inside another <see cref="T:Aspose.Words.Markup.StructuredDocumentTag" />.</item>
- </list>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Markup.StructuredDocumentTag.#ctor(Aspose.Words.DocumentBase,Aspose.Words.Markup.SdtType,Aspose.Words.Markup.MarkupLevel)">
- <summary>
- Initializes a new instance of the <b>Structured document tag</b> class.
- </summary>
- <remarks>
- <para>The following types of SDT can be created:</para>
- <list type="bullet">
- <item>
- <see cref="F:Aspose.Words.Markup.SdtType.Checkbox" />
- </item>
- <item>
- <see cref="F:Aspose.Words.Markup.SdtType.DropDownList" />
- </item>
- <item>
- <see cref="F:Aspose.Words.Markup.SdtType.ComboBox" />
- </item>
- <item>
- <see cref="F:Aspose.Words.Markup.SdtType.Date" />
- </item>
- <item>
- <see cref="F:Aspose.Words.Markup.SdtType.BuildingBlockGallery" />
- </item>
- <item>
- <see cref="F:Aspose.Words.Markup.SdtType.Group" />
- </item>
- <item>
- <see cref="F:Aspose.Words.Markup.SdtType.Picture" />
- </item>
- <item>
- <see cref="F:Aspose.Words.Markup.SdtType.RichText" />
- </item>
- <item>
- <see cref="F:Aspose.Words.Markup.SdtType.PlainText" />
- </item>
- </list>
- </remarks>
- <param name="doc">The owner document.</param>
- <param name="type">Type of SDT node.</param>
- <param name="level">Level of SDT node within the document.</param>
- </member>
- <member name="M:Aspose.Words.Markup.StructuredDocumentTag.#ctor(Aspose.Words.DocumentBase,Aspose.Words.Markup.MarkupLevel)">
- <summary>
- internal AW ctor.
- </summary>
- <remarks>
- By default this ctor does not define things like placeholder, id, control properties etc.
- This is the responsibility of the caller, so you should not use this ctor unless you know what you're doing.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Markup.StructuredDocumentTag.RemoveSelfOnly">
- <summary>
- Removes just this SDT node itself, but keeps the content of it inside the document tree.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.StructuredDocumentTag.RemoveSelfOnly(System.Boolean)">
- <summary>
- Removes just this SDT node itself, but keeps the content of it inside the document tree.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.StructuredDocumentTag.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitStructuredDocumentTagStart(Aspose.Words.Markup.StructuredDocumentTag)" />, then calls <see cref="M:Aspose.Words.Node.Accept(Aspose.Words.DocumentVisitor)" /> for all
- child nodes of the smart tag and calls <see cref="M:Aspose.Words.DocumentVisitor.VisitStructuredDocumentTagEnd(Aspose.Words.Markup.StructuredDocumentTag)" /> at the end.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Markup.StructuredDocumentTag.Clear">
- <summary>
- Clears contents of this structured document tag and displays a placeholder if it is defined.
- </summary>
- <remarks>
- <para>It is not possible to clear contents of a structured document tag if it has revisions.</para>
- <para>If this structured document tag is mapped to custom XML (with using the <see cref="P:Aspose.Words.Markup.StructuredDocumentTag.XmlMapping" />
- property), the referenced XML node is cleared.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.NodeType">
- <summary>
- Returns <b>NodeType.StructuredDocumentTag</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.Placeholder">
- <summary>
- Gets the <see cref="T:Aspose.Words.BuildingBlocks.BuildingBlock" /> containing placeholder text which should be displayed when this SDT run contents are empty,
- the associated mapped XML element is empty as specified via the <see cref="P:Aspose.Words.Markup.StructuredDocumentTag.XmlMapping" /> element
- or the <see cref="P:Aspose.Words.Markup.StructuredDocumentTag.IsShowingPlaceholderText" /> element is true.
- </summary>
- <remarks>Can be null, meaning that the placeholder is not applicable for this Sdt.</remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.PlaceholderName">
- <summary>
- <para>Gets or sets Name of the <see cref="T:Aspose.Words.BuildingBlocks.BuildingBlock" /> containing placeholder text.</para>
- <para>
- BuildingBlock with this name <see cref="P:Aspose.Words.BuildingBlocks.BuildingBlock.Name" /> has to be present in the <see cref="P:Aspose.Words.Document.GlossaryDocument" />
- otherwise <see cref="T:System.InvalidOperationException" /> will occur.</para>
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.Level">
- <summary>
- Gets the level at which this <b>SDT</b> occurs in the document tree.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.SdtType">
- <summary>
- Gets type of this <b>Structured document tag</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.Id">
- <summary>
- <para>Specifies a unique read-only persistent numerical Id for this <b>SDT</b>.</para>
- </summary>
- <remarks>
- <para> Id attribute shall follow these rules:
- <list type="bullet"><item>The document shall retain SDT ids only if the whole document is cloned <see cref="M:Aspose.Words.Document.Clone" />.</item><item>During <see cref="M:Aspose.Words.DocumentBase.ImportNode(Aspose.Words.Node,System.Boolean)" />
- Id shall be retained if import does not cause conflicts with other SDT Ids in
- the target document.</item><item>
- If multiple SDT nodes specify the same decimal number value for the Id attribute,
- then the first SDT in the document shall maintain this original Id,
- and all subsequent SDT nodes shall have new identifiers assigned to them when the document is loaded.
- </item><item>During standalone SDT <see cref="M:Aspose.Words.Markup.StructuredDocumentTag.Clone(System.Boolean,Aspose.Words.INodeCloningListener)" /> operation new unique ID will be generated for the cloned SDT node.</item><item>
- If Id is not specified in the source document, then the SDT node shall have a new unique identifier assigned
- to it when the document is loaded.
- </item></list></para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.LockContentControl">
- <summary>
- When set to true, this property will prohibit a user from deleting this <b>SDT</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.LockContents">
- <summary>
- When set to true, this property will prohibit a user from editing the contents of this <b>SDT</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.IsShowingPlaceholderText">
- <summary>
- <para>
- Specifies whether the content of this <b>SDT</b> shall be interpreted to contain placeholder text
- (as opposed to regular text contents within the SDT).
- </para>
- <para>
- if set to true, this state shall be resumed (showing placeholder text) upon opening this document.
- </para>
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.Tag">
- <summary>
- Specifies a tag associated with the current SDT node.
- Can not be null.
- </summary>
- <remarks> A tag is an arbitrary string which applications can associate with SDT
- in order to identify it without providing a visible friendly name.</remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.ContentsFont">
- <summary>
- Font formatting that will be applied to text entered into <b>SDT</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.EndCharacterFont">
- <summary>
- Font formatting that will be applied to the last character of text entered into <b>SDT</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.IsTemporary">
- <summary>
- Specifies whether this <b>SDT</b> shall be removed from the WordPprocessingML document when its contents
- are modified.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.Title">
- <summary>
- Specifies the friendly name associated with this <b>SDT</b>.
- Can not be null.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.ListItems">
- <summary>
- Gets <see cref="T:Aspose.Words.Markup.SdtListItemCollection" /> associated with this <b>SDT</b>.
- </summary>
- <remarks>
- <para>Accessing this property will only work for <see cref="F:Aspose.Words.Markup.SdtType.ComboBox" /> or <see cref="F:Aspose.Words.Markup.SdtType.DropDownList" />
- SDT types.
- </para>
- <para>For all other SDT types exception will occur.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.Checked">
- <summary>
- Gets/Sets current state of the Checkbox <b>SDT</b>.
- Default value for this property is false.
- </summary>
- <remarks>
- <para>Accessing this property will only work for <see cref="F:Aspose.Words.Markup.SdtType.Checkbox" />
- SDT types.
- </para>
- <para>For all other SDT types exception will occur.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.DateDisplayLocale">
- <summary>
- Allows to set/get the language format for the date displayed in this <b>SDT</b>.
- </summary>
- <remarks>
- <para>Accessing this property will only work for <see cref="F:Aspose.Words.Markup.SdtType.Date" /> SDT type.
- </para>
- <para>For all other SDT types exception will occur.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.DateDisplayFormat">
- <summary>
- String that represents the format in which dates are displayed.
- Can not be null.
- <example>The dates for English (U.S.) is "mm/dd/yyyy"</example></summary>
- <remarks>
- <para>Accessing this property will only work for <see cref="F:Aspose.Words.Markup.SdtType.Date" /> SDT type.
- </para>
- <para>For all other SDT types exception will occur.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.FullDate">
- <summary>
- Specifies the full date and time last entered into this <b>SDT</b>.
- </summary>
- <remarks>
- <para>Accessing this property will only work for <see cref="F:Aspose.Words.Markup.SdtType.Date" /> SDT type.
- </para>
- <para>For all other SDT types exception will occur.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.DateStorageFormat">
- <summary>
- Gets/sets format in which the date for a date SDT is stored when the <b>SDT</b> is bound to an XML node in the document's data store.
- Default value is <see cref="F:Aspose.Words.Markup.SdtDateStorageFormat.DateTime" /></summary>
- <remarks>
- <para>Accessing this property will only work for <see cref="F:Aspose.Words.Markup.SdtType.Date" /> SDT type.
- </para>
- <para>For all other SDT types exception will occur.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.CalendarType">
- <summary>
- Specifies the type of calendar for this <b>SDT</b>.
- Default is <see cref="F:Aspose.Words.Markup.SdtCalendarType.Default" /></summary>
- <remarks>
- <para>Accessing this property will only work for <see cref="F:Aspose.Words.Markup.SdtType.Date" /> SDT type.
- </para>
- <para>For all other SDT types exception will occur.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.BuildingBlockGallery">
- <summary>
- Specifies type of building block for this <b>SDT</b>.
- Can not be null.
- </summary>
- <remarks>
- <para>Accessing this property will only work for <see cref="F:Aspose.Words.Markup.SdtType.BuildingBlockGallery" /> and
- <see cref="F:Aspose.Words.Markup.SdtType.DocPartObj" /> SDT types. It is read-only for <b>SDT</b> of the document part type.
- </para>
- <para>For all other SDT types exception will occur.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.BuildingBlockCategory">
- <summary>
- Specifies category of building block for this <b>SDT</b> node.
- Can not be null.
- </summary>
- <remarks>
- <para>Accessing this property will only work for <see cref="F:Aspose.Words.Markup.SdtType.BuildingBlockGallery" /> and
- <see cref="F:Aspose.Words.Markup.SdtType.DocPartObj" /> SDT types. It is read-only for <b>SDT</b> of the document part type.
- </para>
- <para>For all other SDT types exception will occur.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.Multiline">
- <summary>
- Specifies whether this <b>SDT</b> allows multiple lines of text.
- </summary>
- <remarks>
- <para>Accessing this property will only work for <see cref="F:Aspose.Words.Markup.SdtType.RichText" /> and <see cref="F:Aspose.Words.Markup.SdtType.PlainText" /> SDT type.
- </para>
- <para>For all other SDT types exception will occur.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.Color">
- <summary>
- Gets or sets the color of the structured document tag.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.Style">
- <summary>
- Gets or sets the Style of the structured document tag.
- </summary>
- <remarks>
- Only <see cref="F:Aspose.Words.StyleType.Character" /> style or <see cref="F:Aspose.Words.StyleType.Paragraph" /> style with linked character style can be set.
- </remarks>
- <dev>
- It's ridiculous that Word uses character styles internally but exposes
- linked paragraph styles in GUI and VBA. Anyway, we do the same.
- </dev>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.StyleName">
- <summary>
- Gets or sets the name of the style applied to the structured document tag.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.StructuredDocumentTag.XmlMapping">
- <summary>
- Gets an object that represents the mapping of this structured document tag to XML data
- in a custom XML part of the current document.
- </summary>
- <remarks>
- You can use the <see cref="M:Aspose.Words.Markup.XmlMapping.SetMapping(Aspose.Words.Markup.CustomXmlPart,System.String,System.String)" /> method of this object to map
- a structured document tag to XML data.
- </remarks>
- <dev>
- If this element is present and the parent Sdt is not of a rich text type, then the current
- value of the Sdt shall be determined by finding the XML element (if any) which is
- determined by the attributes on this element.
- See Iso29500, chapter 1, 17.5.2.6 dataBinding (XML Mapping).
- If DataBinding information does not result in an XML element, then the
- application can use any algorithm desired to find the closest available match. If this information does result in an
- XML element, then the contents of that element shall be used to replace the current run content within the
- document.
- </dev>
- </member>
- <member name="T:Aspose.Words.Markup.SdtCalendarType">
- <summary>
- Specifies the possible types of calendars which can be used to specify <see cref="P:Aspose.Words.Markup.StructuredDocumentTag.CalendarType" />
- in an Office Open XML document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.Default">
- <summary>
- Used as default value in OOXML. Equals <see cref="F:Aspose.Words.Markup.SdtCalendarType.Gregorian" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.Gregorian">
- <summary>
- Specifies that the Gregorian calendar, as defined in ISO 8601, shall be used.
- This calendar should be localized into the appropriate language.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.GregorianArabic">
- <summary>
- Specifies that the Gregorian calendar, as defined in ISO 8601, shall be used.
- The values for this calendar should be presented in Arabic.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.GregorianMeFrench">
- <summary>
- Specifies that the Gregorian calendar, as defined in ISO 8601, shall be used.
- The values for this calendar should be presented in Middle East French.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.GregorianUs">
- <summary>
- Specifies that the Gregorian calendar, as defined in ISO 8601, shall be used.
- The values for this calendar should be presented in English.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.GregorianXlitEnglish">
- <summary>
- Specifies that the Gregorian calendar, as defined in ISO 8601, shall be used.
- The values for this calendar should be the representation of the English strings in the corresponding Arabic characters
- (the Arabic transliteration of the English for the Gregorian calendar).
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.GregorianXlitFrench">
- <summary>
- Specifies that the Gregorian calendar, as defined in ISO 8601, shall be used.
- The values for this calendar should be the representation of the French strings in the corresponding Arabic characters
- (the Arabic transliteration of the French for the Gregorian calendar).
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.Hebrew">
- <summary>
- Specifies that the Hebrew lunar calendar, as described by the Gauss formula for Passover [CITATION]
- and The Complete Restatement of Oral Law (Mishneh Torah),shall be used.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.Hijri">
- <summary>
- Specifies that the Hijri lunar calendar, as described by the Kingdom of Saudi Arabia,
- Ministry of Islamic Affairs, Endowments, Da‘wah and Guidance, shall be used.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.Japan">
- <summary>
- Specifies that the Japanese Emperor Era calendar, as described by
- Japanese Industrial Standard JIS X 0301, shall be used.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.Korea">
- <summary>
- Specifies that the Korean Tangun Era calendar,
- as described by Korean Law Enactment No. 4, shall be used.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.None">
- <summary>
- Specifies that no calendar should be used.
- </summary>
- <remarks>
- Usually in AW, None is the first and default value for enums, but not in this case.
- None is not default for OOXML, instead <see cref="F:Aspose.Words.Markup.SdtCalendarType.Gregorian" /> is default and is first member of this enum.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.Saka">
- <summary>
- Specifies that the Saka Era calendar, as described by the Calendar Reform Committee of India,
- as part of the Indian Ephemeris and Nautical Almanac, shall be used.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.Taiwan">
- <summary>
- Specifies that the Taiwanese calendar, as defined by the Chinese National Standard CNS 7648, shall be used.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtCalendarType.Thai">
- <summary>
- Specifies that the Thai calendar, as defined by the Royal Decree of H.M. King Vajiravudh (Rama VI) in
- Royal Gazette B. E. 2456 (1913 A.D.) and by the decree of Prime Minister Phibunsongkhram (1941 A.D.) to
- start the year on the Gregorian January 1 and to map year zero to Gregorian year 543 B.C., shall be used.
- </summary>
- </member>
- <member name="T:Aspose.Words.Markup.SdtListItem">
- <summary>
- This element specifies a single list item within a parent <see cref="F:Aspose.Words.Markup.SdtType.ComboBox" /> or <see cref="F:Aspose.Words.Markup.SdtType.DropDownList" /> structured document tag.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.SdtListItem.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of this class.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.SdtListItem.#ctor(System.String)">
- <summary>
- Initializes a new instance of this class.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.SdtListItem.DisplayText">
- <summary>
- Gets the text to display in the run content in place of the <see cref="P:Aspose.Words.Markup.SdtListItem.Value" /> attribute contents for this list item.
- </summary>
- <remarks>
- <para>Cannot be null and cannot be an empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.SdtListItem.Value">
- <summary>
- Gets the value of this list item.
- </summary>
- <remarks>
- <para>Cannot be null and cannot be an empty string.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Markup.XmlMapping">
- <summary>
- 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.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.XmlMapping.SetMapping(Aspose.Words.Markup.CustomXmlPart,System.String,System.String)">
- <summary>
- Sets a mapping between the parent structured document tag and an XML node of a custom XML data part.
- </summary>
- <param name="customXmlPart">A custom XML data part to map to.</param>
- <param name="xPath">An XPath expression to find the XML node.</param>
- <param name="prefixMapping">XML namespace prefix mappings to evaluate the XPath.</param>
- <returns>A flag indicating whether the parent structured document tag is successfully mapped to
- the XML node.</returns>
- </member>
- <member name="M:Aspose.Words.Markup.XmlMapping.Delete">
- <summary>
- Deletes mapping of the parent structured document to XML data.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.XmlMapping.SetMapping(System.String,System.String,System.String)">
- <summary>
- Sets a mapping between the parent structured document tag and an XML node of a custom XML data part.
- </summary>
- <param name="storeItemId">Identifier of a store item: either a custom XML data part or a storage of
- document properties.</param>
- <param name="xPath">An XPath expression to find the XML node.</param>
- <param name="prefixMapping">XML namespace prefix mappings to evaluate the XPath.</param>
- </member>
- <member name="P:Aspose.Words.Markup.XmlMapping.PrefixMappings">
- <summary>
- Returns XML namespace prefix mappings to evaluate the <see cref="P:Aspose.Words.Markup.XmlMapping.XPath" />.
- </summary>
- <remarks>
- Specifies the set of prefix mappings, which shall be used to interpret the XPath expression
- when the XPath expression is evaluated against the custom XML data parts in the document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.XmlMapping.XPath">
- <summary>
- Returns the XPath expression, which is evaluated to find the custom XML node
- that is mapped to the parent structured document tag.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.XmlMapping.CustomXmlPart">
- <summary>
- Returns the custom XML data part to which the parent structured document tag is mapped.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.XmlMapping.IsMapped">
- <summary>
- Returns <b>true</b> if the parent structured document tag is successfully mapped to XML data.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.XmlMapping.StoreItemId">
- <summary>
- Specifies the custom XML data identifier for the custom XML data part which
- shall be used to evaluate the <see cref="P:Aspose.Words.Markup.XmlMapping.XPath" /> expression.
- </summary>
- </member>
- <member name="T:Aspose.Words.Markup.SdtType">
- <summary>
- Specifies the type of a structured document tag (SDT) node.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.None">
- <summary>
- No type is assigned to the SDT.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.Bibliography">
- <summary>
- The SDT represents a bibliography entry.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.Citation">
- <summary>
- The SDT represents a citation.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.Equation">
- <summary>
- The SDT represents an equation.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.DropDownList">
- <summary>
- The SDT represents a drop down list when displayed in the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.ComboBox">
- <summary>
- The SDT represents a combo box when displayed in the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.Date">
- <summary>
- The SDT represents a date picker when displayed in the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.BuildingBlockGallery">
- <summary>
- The SDT represents a building block gallery type.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.DocPartObj">
- <summary>
- The SDT represents a document part type.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.Group">
- <summary>
- The SDT represents a restricted grouping when displayed in the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.Picture">
- <summary>
- The SDT represents a picture when displayed in the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.RichText">
- <summary>
- The SDT represents a rich text box when displayed in the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.PlainText">
- <summary>
- The SDT represents a plain text box when displayed in the document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.Checkbox">
- <summary>
- The SDT represents a checkbox when displayed in the document.
- </summary>
- <remarks>
- This is MS-specific feature available since Office 2010 and not supported by the ISO/IEC 29500 OOXML standard.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.RepeatingSection">
- <summary>
- The SDT represents repeating section type when displayed in the document.
- </summary>
- <remarks>
- This is MS-specific feature available since Office 2013 and not supported by the ISO/IEC 29500 OOXML standard.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.RepeatingSectionItem">
- <summary>
- The SDT represents repeating section item.
- </summary>
- <remarks>
- This is MS-specific feature available since Office 2013 and not supported by the ISO/IEC 29500 OOXML standard.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Markup.SdtType.EntityPicker">
- <summary>
- The SDT represents an entity picker that allows the user to select an instance of an external content type.
- </summary>
- <remarks>
- This is MS-specific feature available since Office 2010 and not supported by the ISO/IEC 29500 OOXML standard.
- </remarks>
- <dev>
- §2.6.1.15 entityPicker [MS-DOCX].
- Some additional information about entity pickers can be taken from the chapter USING EXTERNAL DATA IN WORD
- of Scot Hillier, Brad Stevenson. Professional Business Connectivity Services in SharePoint 2010.
- </dev>
- </member>
- <member name="T:Aspose.Words.Markup.CustomPart">
- <summary>
- Represents a custom (arbitrary content) part, that is not defined by the ISO/IEC 29500 standard.
- </summary>
- <remarks>
- <para>This class represents an OOXML part that is a target of an "unknown relationship".
- All relationships not defined within ISO/IEC 29500 are considered "unknown relationships".
- Unknown relationships are permitted within an Office Open XML document provided that they
- conform to relationship markup guidelines.</para>
- <para>Microsoft Word preserves custom parts during open/save cycles. Some additional info can be found
- here http://blogs.msdn.com/dmahugh/archive/2006/11/25/arbitrary-content-in-an-opc-package.aspx </para>
- <para>Aspose.Words also roundtrips custom parts and in addition, allows to programmatically access
- such parts via the <see cref="T:Aspose.Words.Markup.CustomPart" /> and <see cref="T:Aspose.Words.Markup.CustomPartCollection" /> objects.</para>
- <para>Do not confuse custom parts with Custom XML Data. Use <see cref="T:Aspose.Words.Markup.CustomXmlPart" /> if you need
- to access Custom XML Data.</para>
- <seealso cref="T:Aspose.Words.Markup.CustomPartCollection" />
- <seealso cref="P:Aspose.Words.Document.PackageCustomParts" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Markup.CustomPart.Clone">
- <summary>
- Makes a "deep enough" copy of the object.
- Does not duplicate the bytes of the <see cref="P:Aspose.Words.Markup.CustomPart.Data" /> value.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.CustomPart.Name">
- <summary>
- Gets or sets this part's absolute name within the OOXML package or the target URL.
- </summary>
- <remarks>
- <para>If the relationship target is internal, then this property is the absolute part name within the package.
- If the relationship target is external, then this property is the target URL.</para>
- <para>The default value is an empty string. A valid value must be a non-empty string.</para>
- <seealso cref="P:Aspose.Words.Markup.CustomPart.IsExternal" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.CustomPart.RelationshipType">
- <summary>
- Gets or sets the relationship type from the parent part to this custom part.
- </summary>
- <remarks>
- <para>The relationship type for a custom part must be "unknown" e.g. a custom relationship type,
- not one of the relationship types defined within ISO/IEC 29500.</para>
- <para>The default value is an empty string. A valid value must be a non-empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.CustomPart.IsExternal">
- <summary>
- <c>False</c> if this custom part is stored inside the OOXML package. <c>True</c> if this custom part is an external target.
- </summary>
- <remarks>
- <para>The default value is <c>false</c>.</para>
- <seealso cref="P:Aspose.Words.Markup.CustomPart.Name" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.CustomPart.ContentType">
- <summary>
- Specifies the content type of this custom part.
- </summary>
- <remarks>
- <para>This property is applicable only when <see cref="P:Aspose.Words.Markup.CustomPart.IsExternal" /> is <c>false</c>.</para>
- <para>The default value is an empty string. A valid value must be a non-empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.CustomPart.Data">
- <summary>
- Contains the data of this custom part.
- </summary>
- <remarks>
- <para>This property is applicable only when <see cref="P:Aspose.Words.Markup.CustomPart.IsExternal" /> is <c>false</c>.</para>
- <para>The default value is an empty byte array. The value cannot be <c>null</c>.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Markup.CustomPartCollection">
- <summary>
- Represents a collection of <see cref="T:Aspose.Words.Markup.CustomPart" /> objects.
- </summary>
- <remarks>
- <para>You do not normally need to create instances of this class. You access custom parts
- related to the OOXML package via the <see cref="P:Aspose.Words.Document.PackageCustomParts" /> property.</para>
- <seealso cref="T:Aspose.Words.Markup.CustomPart" />
- <seealso cref="P:Aspose.Words.Document.PackageCustomParts" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Markup.CustomPartCollection.GetEnumerator">
- <summary>
- Returns an enumerator object that can be used to iterate over all items in the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.CustomPartCollection.Add(Aspose.Words.Markup.CustomPart)">
- <summary>
- Adds an item to the collection.
- </summary>
- <param name="part">The item to add.</param>
- </member>
- <member name="M:Aspose.Words.Markup.CustomPartCollection.RemoveAt(System.Int32)">
- <summary>
- Removes an item at the specified index.
- </summary>
- <param name="index">The zero based index.</param>
- </member>
- <member name="M:Aspose.Words.Markup.CustomPartCollection.Clear">
- <summary>
- Removes all elements from the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.CustomPartCollection.Clone">
- <summary>
- Makes a deep copy of this collection and its items.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.CustomPartCollection.Count">
- <summary>
- Gets the number of elements contained in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.CustomPartCollection.Item(System.Int32)">
- <summary>
- Gets or sets an item at the specified index.
- </summary>
- <param name="index">Zero-based index of the item.</param>
- </member>
- <member name="T:Aspose.Words.Markup.CustomXmlPart">
- <summary>
- Represents a Custom XML Data Storage Part (custom XML data within a package).
- </summary>
- <remarks>
- <para>A DOCX or DOC document can contain one or more Custom XML Data Storage parts. Aspose.Words preserves and
- allows to create and extract Custom XML Data via the <see cref="P:Aspose.Words.Document.CustomXmlParts" /> collection.</para>
- <seealso cref="P:Aspose.Words.Document.CustomXmlParts" />
- <seealso cref="T:Aspose.Words.Markup.CustomXmlPartCollection" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPart.Clone">
- <summary>
- Makes a "deep enough" copy of the object.
- Does not duplicate the bytes of the <see cref="P:Aspose.Words.Markup.CustomXmlPart.Data" /> value.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.CustomXmlPart.Id">
- <summary>
- Gets or sets the string that identifies this custom XML part within an OOXML document.
- </summary>
- <remarks>
- <para>ISO/IEC 29500 specifies that this value is a GUID, but old versions of Microsoft Word allowed any
- string here. Aspose.Words does the same for ECMA-376 format. But note, that Microsoft Word Online fails
- to open a document created with a non-GUID value. So, a GUID is preferred value for this property.</para>
- <para>A valid value must be an identifier that is unique among all custom XML data parts in this document.
- </para>
- <para>The default value is an empty string. The value cannot be <c>null</c>.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.CustomXmlPart.Schemas">
- <summary>
- Specifies the set of XML schemas that are associated with this custom XML part.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.CustomXmlPart.Data">
- <summary>
- Gets or sets the XML content of this Custom XML Data Storage Part.
- </summary>
- <remarks>
- <para>The default value is an empty byte array. The value cannot be <c>null</c>.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Markup.CustomXmlPartCollection">
- <summary>
- Represents a collection of Custom XML Parts. The items are <see cref="T:Aspose.Words.Markup.CustomXmlPart" /> objects.
- </summary>
- <remarks>
- <para>You do not normally need to create instances of this class. You can access custom XML data
- stored in a document via the <see cref="P:Aspose.Words.Document.CustomXmlParts" /> property.</para>
- <seealso cref="T:Aspose.Words.Markup.CustomXmlPart" />
- <seealso cref="P:Aspose.Words.Document.CustomXmlParts" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPartCollection.GetEnumerator">
- <summary>
- Returns an enumerator object that can be used to iterate over all items in the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPartCollection.Add(Aspose.Words.Markup.CustomXmlPart)">
- <summary>
- Adds an item to the collection.
- </summary>
- <param name="part">The custom XML part to add.</param>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPartCollection.Add(System.String,System.String)">
- <summary>
- Creates a new XML part with the specified XML and adds it to the collection.
- </summary>
- <param name="id">Identifier of a new custom XML part.</param>
- <param name="xml">XML data of the part.</param>
- <returns>Created custom XML part.</returns>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPartCollection.RemoveAt(System.Int32)">
- <summary>
- Removes an item at the specified index.
- </summary>
- <param name="index">The zero based index.</param>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPartCollection.Clear">
- <summary>
- Removes all elements from the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPartCollection.GetById(System.String)">
- <summary>
- Finds and returns a custom XML part by its identifier.
- </summary>
- <param name="id">Case-sensitive string that identifies the custom XML part.</param>
- <returns>Returns <c>null</c> if a custom XML part with the specified identifier is not found.</returns>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPartCollection.Clone">
- <summary>
- Makes a deep copy of this collection and its items.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.CustomXmlPartCollection.Count">
- <summary>
- Gets the number of elements contained in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.CustomXmlPartCollection.Item(System.Int32)">
- <summary>
- Gets or sets an item at the specified index.
- </summary>
- <param name="index">Zero-based index of the item.</param>
- </member>
- <member name="T:Aspose.Words.Markup.MarkupLevel">
- <summary>
- Specifies the level in the document tree where a particular <see cref="T:Aspose.Words.Markup.StructuredDocumentTag" /> can occur.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.MarkupLevel.Unknown">
- <summary>
- Specifies the unknown or invalid value.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.MarkupLevel.Inline">
- <summary>
- The element occurs at the inline level (e.g. among as runs of text).
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.MarkupLevel.Block">
- <summary>
- The element occurs at the block level (e.g. among tables and paragraphs).
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.MarkupLevel.Row">
- <summary>
- The element occurs among rows in a table.
- </summary>
- </member>
- <member name="F:Aspose.Words.Markup.MarkupLevel.Cell">
- <summary>
- The element occurs among cells in a row.
- </summary>
- </member>
- <member name="T:Aspose.Words.Markup.CustomXmlProperty">
- <summary>
- Represents a single custom XML attribute or a smart tag property.
- </summary>
- <remarks>
- <para>Used as an item of a <see cref="T:Aspose.Words.Markup.CustomXmlPropertyCollection" /> collection.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlProperty.#ctor(System.String,System.String,System.String)">
- <summary>
- Initializes a new instance of this class.
- </summary>
- <param name="name">The name of the property. Cannot be null.</param>
- <param name="uri">The namespace URI of the property. Cannot be null.</param>
- <param name="value">The value of the property. Cannot be null.</param>
- </member>
- <member name="P:Aspose.Words.Markup.CustomXmlProperty.Name">
- <summary>
- Specifies the name of the custom XML attribute or smart tag property.
- </summary>
- <remarks>
- <para>Cannot be null.</para>
- <para>Default is empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.CustomXmlProperty.Uri">
- <summary>
- Gets or sets the namespace URI of the custom XML attribute or smart tag property.
- </summary>
- <remarks>
- <para>Cannot be null.</para>
- <para>Default is empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.CustomXmlProperty.Value">
- <summary>
- Gets or sets the value of the custom XML attribute or smart tag property.
- </summary>
- <remarks>
- <para>Cannot be null.</para>
- <para>Default is empty string.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Markup.CustomXmlPropertyCollection">
- <summary>
- Represents a collection of custom XML attributes or smart tag properties.
- </summary>
- <remarks>
- <para>Items are <see cref="T:Aspose.Words.Markup.CustomXmlProperty" /> objects.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPropertyCollection.GetEnumerator">
- <summary>
- Returns an enumerator object that can be used to iterate over all items in the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPropertyCollection.Add(Aspose.Words.Markup.CustomXmlProperty)">
- <summary>
- Adds a property to the collection.
- </summary>
- <param name="property">The property to add.</param>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPropertyCollection.Contains(System.String)">
- <summary>
- Determines whether the collection contains a property with the given name.
- </summary>
- <param name="name">Case-sensitive name of the property to locate.</param>
- <returns>True if the item is found in the collection; otherwise, false.</returns>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPropertyCollection.IndexOfKey(System.String)">
- <summary>
- Returns the zero-based index of the specified property in the collection.
- </summary>
- <param name="name">The case-sensitive name of the property.</param>
- <returns>The zero based index. Negative value if not found.</returns>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPropertyCollection.Remove(System.String)">
- <summary>
- Removes a property with the specified name from the collection.
- </summary>
- <param name="name">The case-sensitive name of the property.</param>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPropertyCollection.RemoveAt(System.Int32)">
- <summary>
- Removes a property at the specified index.
- </summary>
- <param name="index">The zero based index.</param>
- </member>
- <member name="M:Aspose.Words.Markup.CustomXmlPropertyCollection.Clear">
- <summary>
- Removes all elements from the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.CustomXmlPropertyCollection.Count">
- <summary>
- Gets the number of elements contained in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.CustomXmlPropertyCollection.Item(System.String)">
- <overloads>Provides access to the collection items.</overloads>
- <summary>
- Gets a property with the specified name.
- </summary>
- <param name="name">Case-sensitive name of the property to locate.</param>
- </member>
- <member name="P:Aspose.Words.Markup.CustomXmlPropertyCollection.Item(System.Int32)">
- <summary>
- Gets a property at the specified index.
- </summary>
- <param name="index">Zero-based index of the property.</param>
- </member>
- <member name="T:Aspose.Words.Markup.NamespaceDoc">
- <summary>
- <p>The <b>Aspose.Words.Markup</b> namespace contains classes that
- represent customer defined semantics in a document: smart tags, custom XML and
- structured document tags (content controls).</p>
- </summary>
- </member>
- <member name="T:Aspose.Words.Markup.SmartTag">
- <summary>
- This element specifies the presence of a smart tag around one or more inline structures
- (runs, images, fields,etc.) within a paragraph.
- </summary>
- <remarks>
- <para>Smart tags is a kind of custom XML markup. Smart tags provide a facility for embedding
- customer-defined semantics into the document via the ability to provide a basic namespace/name
- for a run or set of runs within a document.</para>
- <p>
- <see cref="T:Aspose.Words.Markup.SmartTag" /> can be a child of a <see cref="T:Aspose.Words.Paragraph" /> or
- another <see cref="T:Aspose.Words.Markup.SmartTag" /> node.</p>
- <p>The complete list of child nodes that can occur inside a smart tag consists of
- <see cref="T:Aspose.Words.BookmarkStart" />, <see cref="T:Aspose.Words.BookmarkEnd" />,
- <see cref="T:Aspose.Words.Fields.FieldStart" />, <see cref="T:Aspose.Words.Fields.FieldSeparator" />, <see cref="T:Aspose.Words.Fields.FieldEnd" />, <see cref="T:Aspose.Words.Fields.FormField" />,
- <see cref="T:Aspose.Words.Comment" />, <see cref="T:Aspose.Words.Footnote" />,
- <see cref="T:Aspose.Words.Run" />, <see cref="T:Aspose.Words.SpecialChar" />,
- <see cref="T:Aspose.Words.Drawing.Shape" />, <see cref="T:Aspose.Words.Drawing.GroupShape" />,
- <see cref="T:Aspose.Words.CommentRangeStart" />,
- <see cref="T:Aspose.Words.CommentRangeEnd" />,
- <see cref="T:Aspose.Words.Markup.SmartTag" />.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Markup.SmartTag.#ctor(Aspose.Words.DocumentBase)">
- <summary>
- Initializes a new instance of the <see cref="T:Aspose.Words.Markup.SmartTag" /> class.
- </summary>
- <remarks>
- <para>When you create a new node, you need to specify a document to which the node belongs.
- A node cannot exist without a document because it depends on the document-wide structures
- such as lists and styles. Although a node always belongs to a document, a node might or might
- not be a part of the document tree.</para>
- <para>When a node is created, it belongs to a document, but is not yet part of the document tree
- and <see cref="P:Aspose.Words.Node.ParentNode" /> is null. To insert a node into the document, use the
- <see cref="M:Aspose.Words.CompositeNode.InsertAfter(Aspose.Words.Node,Aspose.Words.Node)" /> or <see cref="M:Aspose.Words.CompositeNode.InsertBefore(Aspose.Words.Node,Aspose.Words.Node)" /> methods
- on the parent node.</para>
- </remarks>
- <param name="doc">The owner document.</param>
- </member>
- <member name="M:Aspose.Words.Markup.SmartTag.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitSmartTagStart(Aspose.Words.Markup.SmartTag)" />, then calls <see cref="M:Aspose.Words.Node.Accept(Aspose.Words.DocumentVisitor)" /> for all
- child nodes of the smart tag and calls <see cref="M:Aspose.Words.DocumentVisitor.VisitSmartTagEnd(Aspose.Words.Markup.SmartTag)" /> at the end.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.SmartTag.NodeType">
- <summary>
- Returns <b>NodeType.SmartTag</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Markup.SmartTag.Element">
- <summary>
- Specifies the name of the smart tag within the document.
- </summary>
- <remarks>
- <para>Cannot be null.</para>
- <para>Default is empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.SmartTag.Uri">
- <summary>
- Specifies the namespace URI of the smart tag.
- </summary>
- <remarks>
- <para>Cannot be null.</para>
- <para>Default is empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Markup.SmartTag.Properties">
- <summary>
- A collection of the smart tag properties.
- </summary>
- <remarks>
- <para>Cannot be null.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Lists.ListLabel">
- <summary>
- Defines properties specific to a list label.
- </summary>
- <dev>
- <para>Implements <see cref="T:Aspose.Words.IRunAttrSource" /> interface treating list level direct formatting
- as direct run attributes since they take priority over the other sources.</para>
- <para>
- <see cref="T:Aspose.Words.Lists.ListLabel" /> contains the most common textual representation of the list label
- in its <see cref="P:Aspose.Words.Lists.ListLabel.LabelString" /> property.</para>
- <para>There are some classes which need different textual representation of list labels. Use
- <see cref="T:Aspose.Words.Lists.ListLabel" />'s property <see cref="P:Aspose.Words.Lists.ListLabel.NumberState" /> which introduced to provide enough information
- to build custom labels from the inside of such classes.</para>
- <para>Both <see cref="P:Aspose.Words.Lists.ListLabel.LabelString" /> and <see cref="P:Aspose.Words.Lists.ListLabel.NumberState" /> are updated
- by <see cref="M:Aspose.Words.Document.UpdateListLabels" />.</para>
- </dev>
- </member>
- <member name="P:Aspose.Words.Lists.ListLabel.Font">
- <summary>
- Gets the list label font.
- </summary>
- </member>
- <member name="P:Aspose.Words.Lists.ListLabel.LabelString">
- <summary>
- Gets a string representation of list label.
- </summary>
- </member>
- <member name="P:Aspose.Words.Lists.ListLabel.LabelValue">
- <summary>
- Gets a numeric value for this label.
- </summary>
- <remarks>
- Use the <see cref="M:Aspose.Words.Document.UpdateListLabels" /> method to update the value of this property.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Lists.List">
- <summary>
- Represents formatting of a list.
- </summary>
- <remarks>
- <p>A list in a Microsoft Word document is a set of list formatting properties.
- Each list can have up to 9 levels and formatting properties, such as number style, start value,
- indent, tab position etc are defined separately for each level.</p>
- <p>A <see cref="T:Aspose.Words.Lists.List" /> object always belongs to the <see cref="T:Aspose.Words.Lists.ListCollection" /> collection.</p>
- <p>To create a new list, use the Add methods of the <see cref="T:Aspose.Words.Lists.ListCollection" /> collection.</p>
- <p>To modify formatting of a list, use <see cref="T:Aspose.Words.Lists.ListLevel" /> objects found in
- the <see cref="P:Aspose.Words.Lists.List.ListLevels" /> collection.</p>
- <p>To apply or remove list formatting from a paragraph, use <see cref="T:Aspose.Words.ListFormat" />.</p>
- <seealso cref="T:Aspose.Words.Lists.ListCollection" />
- <seealso cref="T:Aspose.Words.Lists.ListLevel" />
- <seealso cref="T:Aspose.Words.ListFormat" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Lists.List.Equals(Aspose.Words.Lists.List)">
- <summary>
- Compares with the specified list.
- </summary>
- </member>
- <member name="M:Aspose.Words.Lists.List.GetHashCode">
- <summary>
- Calculates hash code for this list object.
- </summary>
- <dev>
- To be compatible with the <see cref="M:Aspose.Words.Lists.List.Equals(System.Object)" /> method, only properties that affect visual
- representation of the list should be included into the calculation. List ID and similar properties
- are ignored.
- </dev>
- </member>
- <member name="M:Aspose.Words.Lists.List.CompareTo(System.Object)">
- <summary>
- Compares the specified object to the current object.
- </summary>
- </member>
- <member name="M:Aspose.Words.Lists.List.CompareTo(Aspose.Words.Lists.List)">
- <summary>
- Compares the specified list to the current list.
- </summary>
- </member>
- <member name="P:Aspose.Words.Lists.List.ListId">
- <summary>
- Gets the unique identifier of the list.
- </summary>
- <remarks>
- <p>You do not normally need to use this property. But if you use it, you normally do so
- in conjunction with the <see cref="M:Aspose.Words.Lists.ListCollection.GetListByListId(System.Int32)" /> method to find a
- list by its identifier.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.List.Document">
- <summary>
- Gets the owner document.
- </summary>
- <remarks>
- <p>A list always has a parent document and is valid only in the context of that document.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.List.IsMultiLevel">
- <summary>
- Returns true when the list contains 9 levels; false when 1 level.
- </summary>
- <remarks>
- <p>The lists that you create with Aspose.Words are always multi-level lists and contain 9 levels.</p>
- <p>Microsoft Word 2003 and later always create multi-level lists with 9 levels.
- But in some documents, created with earlier versions of Microsoft Word you might encounter
- lists that have 1 level only.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.List.ListLevels">
- <summary>
- Gets the collection of list levels for this list.
- </summary>
- <remarks>
- <p>Use this property to access and modify formatting individual to each level of the list.</p>
- </remarks>
- <dev>
- RK This might be a bit nasty because it provides access to the terminal list level definitions,
- e.g. it could return the list level definitions from the list style that is referenced by this list.
- So if the user modifies the formatting of a list level he could actually be modifying the list style.
- But let's leave this for now because this property is mostly accessed to actually get the terminal
- formatting of list levels.
- </dev>
- </member>
- <member name="P:Aspose.Words.Lists.List.IsRestartAtEachSection">
- <summary>
- Specifies whether list should be restarted at each section.
- Default value is <b>false</b>.
- </summary>
- <remarks>
- <p>This option is supported only in RTF, DOC and DOCX document formats.</p>
- <p>This option will be written to DOCX only if <see cref="T:Aspose.Words.Saving.OoxmlCompliance" /> is higher then <see cref="F:Aspose.Words.Saving.OoxmlCompliance.Ecma376_2006" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.List.IsListStyleDefinition">
- <summary>
- Returns true if this list is a definition of a list style.
- </summary>
- <remarks>
- <p>When this property is true, the <see cref="P:Aspose.Words.Lists.List.Style" /> property returns the list style that
- this list defines.</p>
- <p>By modifying properties of a list that defines a list style, you modify the properties
- of the list style.</p>
- <p>A list that is a definition of a list style cannot be applied directly to paragraphs
- to make them numbered.</p>
- <seealso cref="P:Aspose.Words.Lists.List.Style" />
- <seealso cref="P:Aspose.Words.Lists.List.IsListStyleReference" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.List.IsListStyleReference">
- <summary>
- Returns true if this list is a reference to a list style.
- </summary>
- <remarks>
- <p>Note, modifying properties of a list that is a reference to list style has no effect.
- The list formatting specified in the list style itself always takes precedence.</p>
- <seealso cref="P:Aspose.Words.Lists.List.Style" />
- <seealso cref="P:Aspose.Words.Lists.List.IsListStyleDefinition" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.List.Style">
- <summary>
- Gets the list style that this list references or defines.
- </summary>
- <remarks>
- <p>If this list is not associated with a list style, the property will return null.</p>
- <p>A list could be a reference to a list style, in this case <see cref="P:Aspose.Words.Lists.List.IsListStyleReference" />
- will be true.</p>
- <p>A list could be a definition of a list style, in this case <see cref="P:Aspose.Words.Lists.List.IsListStyleDefinition" />
- will be true. Such a list cannot be applied to paragraphs in the document directly.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Lists.ListLevel">
- <summary>
- Defines formatting for a list level.
- </summary>
- <remarks>
- <p>You do not create objects of this class. List level objects are created automatically
- when a list is created. You access <see cref="T:Aspose.Words.Lists.ListLevel" /> objects via the
- <see cref="T:Aspose.Words.Lists.ListLevelCollection" /> collection.</p>
- <p>Use the properties of <see cref="T:Aspose.Words.Lists.ListLevel" /> to specify list formatting
- for individual list levels.</p>
- </remarks>
- <dev>
- Not sure where lvlElt.tplc is stored in the DOC file.
- Sounds like it is a template code for individual list levels.
- VA: All tplc are stored in a separate table in a document.
- They can be seen in binary going one after another.
- Not sure how to locate them in the document structure though.
- </dev>
- </member>
- <member name="M:Aspose.Words.Lists.ListLevel.CreatePictureBullet">
- <summary>
- Creates picture bullet shape for the current list level.
- </summary>
- <remarks>Please note, NumberStyle will be set to Bullet and
- NumberFormat to "\xF0B7" to properly display picture bullet.
- Red cross image will be set as picture bullet image upon creating.
- To change it please use <see cref="P:Aspose.Words.Lists.ListLevel.ImageData" />.</remarks>
- </member>
- <member name="M:Aspose.Words.Lists.ListLevel.DeletePictureBullet">
- <summary>
- Deletes picture bullet for the current list level.
- </summary>
- <remarks>Default bullet will be shown after deleting.</remarks>
- </member>
- <member name="M:Aspose.Words.Lists.ListLevel.Equals(Aspose.Words.Lists.ListLevel)">
- <summary>
- Compares with the specified ListLevel.
- </summary>
- </member>
- <member name="M:Aspose.Words.Lists.ListLevel.GetHashCode">
- <summary>
- Calculates hash code for this object.
- </summary>
- <dev>
- To be compatible with the <see cref="M:Aspose.Words.Lists.ListLevel.Equals(Aspose.Words.Lists.ListLevel)" /> method, only properties that affect visual
- representation of the list are included into the calculation. Object ID and similar properties should
- be ignored.
- </dev>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevel.StartAt">
- <summary>
- Returns or sets the starting number for this list level.
- </summary>
- <remarks>
- <p>Default value is 1.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevel.NumberStyle">
- <summary>
- Returns or sets the number style for this list level.
- </summary>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevel.NumberFormat">
- <summary>
- Returns or sets the number format for the list level.
- </summary>
- <remarks>
- <p>Among normal text characters, the string can contain placeholder characters \x0000 to \x0008
- representing the numbers from the corresponding list levels.</p>
- <p>For example, the string "\x0000.\x0001)" will generate a list label
- that looks something like "1.5)". The number "1" is the current number from
- the 1st list level, the number "5" is the current number from the 2nd list level.</p>
- <p>Null is not allowed, but an empty string meaning no number is valid.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevel.Alignment">
- <summary>
- Gets or sets the justification of the actual number of the list item.
- </summary>
- <remarks>
- <p>The list label is justified relative to the <see cref="P:Aspose.Words.Lists.ListLevel.NumberPosition" /> property.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevel.IsLegal">
- <summary>
- True if the level turns all inherited numbers to Arabic, false if it preserves their number style.
- </summary>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevel.RestartAfterLevel">
- <summary>
- Sets or returns the list level that must appear before the specified list level restarts numbering.
- </summary>
- <remarks>
- <para>The value of -1 means the numbering will continue.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevel.TrailingCharacter">
- <summary>
- Returns or sets the character inserted after the number for the list level.
- </summary>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevel.Font">
- <summary>
- Specifies character formatting used for the list label.
- </summary>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevel.TabPosition">
- <summary>
- Returns or sets the tab position (in points) for the list level.
- </summary>
- <remarks>
- <p>Has effect only when <see cref="P:Aspose.Words.Lists.ListLevel.TrailingCharacter" /> is a tab.</p>
- <seealso cref="P:Aspose.Words.Lists.ListLevel.NumberPosition" />
- <seealso cref="P:Aspose.Words.Lists.ListLevel.TextPosition" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevel.NumberPosition">
- <summary>
- Returns or sets the position (in points) of the number or bullet for the list level.
- </summary>
- <remarks>
- <p>
- <see cref="P:Aspose.Words.Lists.ListLevel.NumberPosition" /> corresponds to LeftIndent plus FirstLineIndent of the paragraph.</p>
- <seealso cref="P:Aspose.Words.Lists.ListLevel.TextPosition" />
- <seealso cref="P:Aspose.Words.Lists.ListLevel.TabPosition" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevel.TextPosition">
- <summary>
- Returns or sets the position (in points) for the second line of wrapping text for the list level.
- </summary>
- <remarks>
- <p>
- <see cref="P:Aspose.Words.Lists.ListLevel.TextPosition" /> corresponds to LeftIndent of the paragraph.</p>
- <seealso cref="P:Aspose.Words.Lists.ListLevel.NumberPosition" />
- <seealso cref="P:Aspose.Words.Lists.ListLevel.TabPosition" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevel.LinkedStyle">
- <summary>
- Gets or sets the paragraph style that is linked to this list level.
- </summary>
- <remarks>
- <p>This property is null when the list level is not linked to a paragraph style.
- This property can be set to null.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevel.ImageData">
- <summary>
- Returns image data of the picture bullet shape for the current list level.
- </summary>
- <remarks>
- If this level doesn't define picture bullet returns null.
- Before setting new image for non picture bullet shape, please use <see cref="M:Aspose.Words.Lists.ListLevel.CreatePictureBullet" /> method first.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Lists.ListLevelAlignment">
- <summary>
- Specifies alignment for the list number or bullet.
- </summary>
- <remarks>
- <p>Used as a value for the <see cref="P:Aspose.Words.Lists.ListLevel.Alignment" /> property.</p>
- </remarks>
- </member>
- <member name="F:Aspose.Words.Lists.ListLevelAlignment.Left">
- <summary>
- The list label is aligned to the left of the number position.
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListLevelAlignment.Center">
- <summary>
- The list label is centered at the number position.
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListLevelAlignment.Right">
- <summary>
- This list label is aligned to the right of the number position.
- </summary>
- </member>
- <member name="T:Aspose.Words.Lists.ListLevelCollection">
- <summary>
- A collection of list formatting for each level in a list.
- </summary>
- </member>
- <member name="M:Aspose.Words.Lists.ListLevelCollection.GetEnumerator">
- <summary>
- Gets the enumerator object that will enumerate levels in this list.
- </summary>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevelCollection.Item(System.Int32)">
- <summary>
- Gets a list level by index.
- </summary>
- </member>
- <member name="P:Aspose.Words.Lists.ListLevelCollection.Count">
- <summary>
- Gets the number of levels in this list.
- </summary>
- <remarks>
- <p>There could be 1 or 9 levels in a list.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Lists.ListCollection">
- <summary>
- Stores and manages formatting of bulleted and numbered lists used in a document.
- </summary>
- <remarks>
- <p>A list in a Microsoft Word document is a set of list formatting properties.
- The formatting of the lists is stored in the <see cref="T:Aspose.Words.Lists.ListCollection" /> collection separately
- from the paragraphs of text.</p>
- <p>You do not create objects of this class. There is always only one <see cref="T:Aspose.Words.Lists.ListCollection" />
- object per document and it is accessible via the <see cref="P:Aspose.Words.DocumentBase.Lists" /> property.</p>
- <p>To create a new list based on a predefined list template or based on a list style,
- use the <see cref="M:Aspose.Words.Lists.ListCollection.Add(Aspose.Words.Style)" /> method.</p>
- <p>To create a new list with formatting identical to an existing list,
- use the <see cref="M:Aspose.Words.Lists.ListCollection.AddCopy(Aspose.Words.Lists.List)" /> method.</p>
- <p>To make a paragraph bulleted or numbered, you need to apply list formatting
- to a paragraph by assigning a <see cref="T:Aspose.Words.Lists.List" /> object to the
- <see cref="P:Aspose.Words.ListFormat.List" /> property of <see cref="T:Aspose.Words.ListFormat" />.</p>
- <p>To remove list formatting from a paragraph, use the <see cref="M:Aspose.Words.ListFormat.RemoveNumbers" />
- method.</p>
- <p>If you know a bit about WordprocessingML, then you might know it defines separate concepts
- for "list" and "list definition". This exactly corresponds to how list formatting is stored
- in a Microsoft Word document at the low level. List definition is like a "schema" and
- list is like an instance of a list definition.</p>
- <p>To simplify programming model, Aspose.Words hides the distinction between list and list
- definition in much the same way like Microsoft Word hides this in its user interface.
- This allows you to concentrate more on how you want your document to look like, rather than
- building low-level objects to satisfy requirements of the Microsoft Word file format.</p>
- <p>It is not possible to delete lists once they are created in the current version of Aspose.Words.
- This is similar to Microsoft Word where user does not have explicit control over list definitions.</p>
- <seealso cref="T:Aspose.Words.Lists.List" />
- <seealso cref="T:Aspose.Words.Lists.ListLevel" />
- <seealso cref="T:Aspose.Words.ListFormat" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Lists.ListCollection.GetEnumerator">
- <summary>
- Gets the enumerator object that will enumerate lists in the document.
- </summary>
- </member>
- <member name="M:Aspose.Words.Lists.ListCollection.Add(Aspose.Words.Lists.ListTemplate)">
- <overloads>Creates a new list and adds it to the collection of lists in the document.</overloads>
- <summary>
- Creates a new list based on a predefined template and adds it to the collection of lists in the document.
- </summary>
- <param name="listTemplate">The template of the list.</param>
- <returns>The newly created list.</returns>
- <remarks>
- <p>Aspose.Words list templates correspond to the 21 list templates available
- in the Bullets and Numbering dialog box in Microsoft Word 2003.</p>
- <p>All lists created using this method have 9 list levels.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Lists.ListCollection.Add(Aspose.Words.Style)">
- <summary>
- Creates a new list that references a list style and adds it to the collection of lists in the document.
- </summary>
- <param name="listStyle">The list style.</param>
- <returns>The newly created list.</returns>
- <remarks>
- <p>The newly created list references the list style. If you change the properties of the list
- style, it is reflected in the properties of the list. Vice versa, if you change the properties
- of the list, it is reflected in the properties of the list style.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Lists.ListCollection.AddCopy(Aspose.Words.Lists.List)">
- <summary>
- Creates a new list by copying the specified list and adding it to the collection of lists in the document.
- </summary>
- <param name="srcList">The source list to copy from.</param>
- <returns>The newly created list.</returns>
- <remarks>
- <p>The source list can be from any document. If the source list belongs to a different document,
- a copy of the list is created and added to the current document.</p>
- <p>If the source list is a reference to or a definition of a list style,
- the newly created list is not related to the original list style.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Lists.ListCollection.AddCopy(Aspose.Words.Lists.List,System.Boolean)">
- <summary>
- Creates a new list by copying the specified list and adding it to the collection of lists in the document.
- </summary>
- <remarks>
- When AW copies only style from other document, AW shouldn't import all dependent styles.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Lists.ListCollection.GetListByListId(System.Int32)">
- <summary>
- Gets a list by a list identifier.
- </summary>
- <param name="listId">The list identifier.</param>
- <returns>Returns the list object. Returns null if a list with the specified identifier was not found.</returns>
- <remarks>
- <p>You don't normally need to use this method. Most of the time you apply list formatting
- to paragraphs just by settings the <see cref="P:Aspose.Words.ListFormat.List" /> property
- of the <see cref="T:Aspose.Words.ListFormat" /> object.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Lists.ListCollection.Count">
- <summary>
- Gets the count of numbered and bulleted lists in the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Lists.ListCollection.Item(System.Int32)">
- <summary>
- Gets a list by index.
- </summary>
- </member>
- <member name="P:Aspose.Words.Lists.ListCollection.Item(System.String)">
- <summary>
- Gets a list by <see cref="T:Aspose.Words.Lists.ListDef" /> name. Returns <b>null</b> if not found.
- </summary>
- <remarks>
- MS Word does not give an ability to create more than one list based on named <see cref="T:Aspose.Words.Lists.ListDef" />
- through its GUI and AW does not set <see cref="P:Aspose.Words.Lists.ListDef.Name" /> anywhere outside of file reading
- routines so <see cref="T:Aspose.Words.Lists.ListDef" /> name can be the unique identifier for a list.
- </remarks>
- <param name="listDefName">
- </param>
- <returns>
- </returns>
- </member>
- <member name="P:Aspose.Words.Lists.ListCollection.Document">
- <summary>
- Gets the owner document.
- </summary>
- </member>
- <member name="T:Aspose.Words.Lists.ListTemplate">
- <summary>
- Specifies one of the predefined list formats available in Microsoft Word.
- </summary>
- <remarks>
- <p>A list template value is used as a parameter into the
- <see cref="M:Aspose.Words.Lists.ListCollection.Add(Aspose.Words.Lists.ListTemplate)" /> method.</p>
- <p>Aspose.Words list templates correspond to the 21 list templates available
- in the Bullets and Numbering dialog box in Microsoft Word 2003.</p>
- </remarks>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.BulletDefault">
- <summary>
- <p>Default bulleted list with 9 levels. Bullet of the first level is a disc,
- bullet of the second level is a circle, bullet of the third level is a square.
- Then formatting repeats for the remaining levels.</p>
- <p>Each level is indented to the right by 0.25" relative to the previous level.</p>
- <p>Corresponds to the 1st bulleted list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.BulletDisk">
- <summary>
- <p>Same as BulletDefault.</p>
- <p>Corresponds to the 1st bulleted list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.BulletCircle">
- <summary>
- <p>The bullet of the first level is a circle. The remaining levels are same as in BulletDefault.</p>
- <p>Corresponds to the 2nd bulleted list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.BulletSquare">
- <summary>
- <p>The bullet of the first level is a square. The remaining levels are same as in BulletDefault.</p>
- <p>Corresponds to the 3rd bulleted list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.BulletDiamonds">
- <summary>
- <p>The bullet of the first level is a 4-diamond Wingding character. The remaining levels are same as in BulletDefault.</p>
- <p>Corresponds to the 5th bulleted list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.BulletArrowHead">
- <summary>
- <p>The bullet of the first level is an arrow head Wingding character. The remaining levels are same as in BulletDefault.</p>
- <p>Corresponds to the 6th bulleted list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.BulletTick">
- <summary>
- <p>The bullet of the first level is a tick Wingding character. The remaining levels are same as in BulletDefault.</p>
- <p>Corresponds to the 7th bulleted list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.NumberDefault">
- <summary>
- <p>Default numbered list with 9 levels. Arabic numbering (1., 2., 3., ...) for the first level,
- lowecase letter numbering (a., b., c., ...) for the second level,
- lowercase roman numbering (i., ii., iii., ...) for the third level.
- Then formatting repeats for the remaining levels.</p>
- <p>Each level is indented to the right by 0.25" relative to the previous level.</p>
- <p>Corresponds to the 1st numbered list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.NumberArabicDot">
- <summary>
- <p>Same as NumberDefault.</p>
- <p>Corresponds to the 1st numbered list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.NumberArabicParenthesis">
- <summary>
- <p>The number of the first level is "1)". The remaining levels are same as in NumberDefault.</p>
- <p>Corresponds to the 2nd numbered list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.NumberUppercaseRomanDot">
- <summary>
- <p>The number of the first level is "I.". The remaining levels are same as in NumberDefault.</p>
- <p>Corresponds to the 3rd numbered list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.NumberUppercaseLetterDot">
- <summary>
- <p>The number of the first level is "A.". The remaining levels are same as in NumberDefault.</p>
- <p>Corresponds to the 4th numbered list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.NumberLowercaseLetterParenthesis">
- <summary>
- <p>The number of the first level is "a)". The remaining levels are same as in NumberDefault.</p>
- <p>Corresponds to the 5th numbered list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.NumberLowercaseLetterDot">
- <summary>
- <p>The number of the first level is "a.". The remaining levels are same as in NumberDefault.</p>
- <p>Corresponds to the 6th numbered list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.NumberLowercaseRomanDot">
- <summary>
- <p>The number of the first level is "i.". The remaining levels are same as in NumberDefault.</p>
- <p>Corresponds to the 7th numbered list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.OutlineNumbers">
- <summary>
- <p>An outline list with levels numbered "1), a), i), (1), (a), (i), 1., a., i.".</p>
- <p>Corresponds to the 1st outline list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.OutlineLegal">
- <summary>
- <p>An outline list with levels are numbered "1., 1.1., 1.1.1, ...".</p>
- <p>Corresponds to the 2nd outline list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.OutlineBullets">
- <summary>
- <p>An outline lists with various bullets for different levels.</p>
- <p>Corresponds to the 3rd outline list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.OutlineHeadingsArticleSection">
- <summary>
- <p>An outline list with levels linked to Heading styles.</p>
- <p>Corresponds to the 4th outline list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.OutlineHeadingsLegal">
- <summary>
- <p>An outline list with levels linked to Heading styles.</p>
- <p>Corresponds to the 5th outline list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.OutlineHeadingsNumbers">
- <summary>
- <p>An outline list with levels linked to Heading styles.</p>
- <p>Corresponds to the 6th outline list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTemplate.OutlineHeadingsChapter">
- <summary>
- <p>An outline list with levels linked to Heading styles.</p>
- <p>Corresponds to the 7th outline list template in the Bullets and Numbering dialog box in Microsoft Word.</p>
- </summary>
- </member>
- <member name="T:Aspose.Words.Lists.ListTrailingCharacter">
- <summary>
- Specifies the character that separates the list label from the text of the paragraph.
- </summary>
- <remarks>
- <p>Used as a value for the <see cref="P:Aspose.Words.Lists.ListLevel.TrailingCharacter" /> property.</p>
- </remarks>
- </member>
- <member name="F:Aspose.Words.Lists.ListTrailingCharacter.Tab">
- <summary>
- A tab character is placed between the list label and text of the paragraph.
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTrailingCharacter.Space">
- <summary>
- A space character is placed between the list label and text of the paragraph.
- </summary>
- </member>
- <member name="F:Aspose.Words.Lists.ListTrailingCharacter.Nothing">
- <summary>
- There is no separator character between the list label and text of the paragraph.
- </summary>
- </member>
- <member name="T:Aspose.Words.Lists.NamespaceDoc">
- <summary>
- <p>The <b>Aspose.Words.Lists</b> namespace contains classes for working
- with bulleted and numbered lists defined in a document.</p>
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.DefaultFontSubstitutionRule">
- <summary>
- Default font substitution rule.
- </summary>
- <remarks>
- This rule defines single default font name to be used for substitution if the original font is not available.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fonts.DefaultFontSubstitutionRule.DefaultFontName">
- <summary>
- Gets or sets the default font name.
- </summary>
- <remarks>
- <para>The default value is 'Times New Roman'.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fonts.FontNameSubstitutionRule">
- <summary>
- Font substitution rule for processing font name.
- </summary>
- <remarks>
- According to this rule Aspose.Words tries to process the font name to get the substitution. Particularly
- Aspose.Words tries to removes suffixes with '-' and ',' separators like it does the MS Word.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fonts.FontConfigSubstitutionRule">
- <summary>
- Font config substitution rule.
- </summary>
- <remarks>
- <para>
- This rule uses fontconfig utility on Linux (and other Unix-like) platforms to get the substitution
- if the original font is not available.
- </para>
- <para>
- If fontconfig utility is not available then this rule will be ignored.
- </para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fonts.FontConfigSubstitutionRule.IsFontConfigAvailable">
- <summary>
- Check if fontconfig utility is available or not.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fonts.FontConfigSubstitutionRule.ResetCache">
- <summary>
- Resets the cache of fontconfig calling results.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FontConfigSubstitutionRule.Enabled">
- <summary>
- Specifies whether the rule is enabled or not.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.FontInfoSubstitutionRule">
- <summary>
- Font info substitution rule.
- </summary>
- <remarks>
- According to this rule Aspose.Words evaluates all the related fields in <see cref="T:Aspose.Words.Fonts.FontInfo" /> (Panose, Sig etc) for
- the missing font and finds the closest match among the available font sources. If <see cref="T:Aspose.Words.Fonts.FontInfo" /> is not
- available for the missing font then nothing will be done.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fonts.FontSubstitutionRule">
- <summary>
- This is an abstract base class for the font substitution rule.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FontSubstitutionRule.Enabled">
- <summary>
- Specifies whether the rule is enabled or not.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.FontSubstitutionSettings">
- <summary>
- Specifies font substitution mechanism settings.
- </summary>
- <remarks>
- <para>
- Font substitution process consists of several rules which are checked one by one in specific order.
- If the first rule can't resolve the font then second rule is checked and so on.</para>
- <para>The order of the rules is following:
- 1. Font name substitution rule (enabled by default)
- 2. Font config substitution rule (disabled by default)
- 3. Table substitution rule (enabled by default)
- 4. Font info substitution rule (enabled by default)
- 5. Default font rule (enabled by default)
- </para>
- <para>
- Note that font info substitution rule will always resolve the font if <see cref="T:Aspose.Words.Fonts.FontInfo" /> is available
- and will override the default font rule. If you want to use the default font rule then you should disable the
- font info substitution rule.
- </para>
- <para>
- Note that font config substitution rule will resolve the font in most cases and thus overrides all other rules.
- </para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fonts.FontSubstitutionSettings.TableSubstitution">
- <summary>
- Settings related to table substitution rule.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FontSubstitutionSettings.FontInfoSubstitution">
- <summary>
- Settings related to font info substitution rule.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FontSubstitutionSettings.DefaultFontSubstitution">
- <summary>
- Settings related to default font substitution rule.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FontSubstitutionSettings.FontConfigSubstitution">
- <summary>
- Settings related to font config substitution rule.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FontSubstitutionSettings.FontNameSubstitution">
- <summary>
- Settings related to font name substitution rule.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.StreamFontSource">
- <summary>
- Base class for user-defined stream font source.
- </summary>
- <remarks>
- <para>In order to use the stream font source you should create a derived class from the <see cref="T:Aspose.Words.Fonts.StreamFontSource" />
- and provide implementation of the <see cref="M:Aspose.Words.Fonts.StreamFontSource.OpenFontDataStream" /> method.</para>
- <para>
- <see cref="M:Aspose.Words.Fonts.StreamFontSource.OpenFontDataStream" /> method could be called several times. For the first time it will be called
- when Aspose.Words scans the provided font sources to get the list of available fonts. Later it may be called if the
- font is used in the document to parse the font data and to embed the font data to some output formats.</para>
- <para>
- <see cref="T:Aspose.Words.Fonts.StreamFontSource" /> may be useful because it allows to load the font data only when it is required
- and not to store it in the memory for the <see cref="T:Aspose.Words.Fonts.FontSettings" /> lifetime.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fonts.StreamFontSource.OpenFontDataStream">
- <summary>
- This method should open the stream with font data on demand.
- </summary>
- <returns>Font data stream.</returns>
- <remarks>
- The stream will be closed after reading. There is no need to close it explicitly.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fonts.StreamFontSource.Type">
- <summary>
- Returns the type of the font source.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.TableSubstitutionRule">
- <summary>
- Table font substitution rule.
- </summary>
- <remarks>
- This rule defines the list of substitute font names to be used if the original font is not available.
- Substitutes will be checked for the font name and the <see cref="P:Aspose.Words.Fonts.FontInfo.AltName" /> (if any).
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fonts.TableSubstitutionRule.Load(System.String)">
- <summary>
- Loads table substitution settings from XML file.
- </summary>
- <param name="fileName">Input file name.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.TableSubstitutionRule.Load(System.IO.Stream)">
- <summary>
- Loads table substitution settings from XML stream.
- </summary>
- <param name="stream">Input stream.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.TableSubstitutionRule.LoadWindowsSettings">
- <summary>
- Loads predefined table substitution settings for Windows platform.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fonts.TableSubstitutionRule.LoadLinuxSettings">
- <summary>
- Loads predefined table substitution settings for Linux platform.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fonts.TableSubstitutionRule.LoadAndroidSettings">
- <summary>
- Loads predefined table substitution settings for Linux platform.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fonts.TableSubstitutionRule.Save(System.String)">
- <summary>
- Saves the current table substitution settings to file.
- </summary>
- <param name="fileName">Output file name.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.TableSubstitutionRule.Save(System.IO.Stream)">
- <summary>
- Saves the current table substitution settings to stream.
- </summary>
- <param name="outputStream">Output stream.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.TableSubstitutionRule.GetSubstitutes(System.String)">
- <summary>
- Returns array containing substitute font names for the specified original font name.
- </summary>
- <param name="originalFontName">Original font name.</param>
- <returns>List of alternative font names.</returns>
- </member>
- <member name="M:Aspose.Words.Fonts.TableSubstitutionRule.SetSubstitutes(System.String,System.String[])">
- <summary>
- Override substitute font names for given original font name.
- </summary>
- <param name="originalFontName">Original font name.</param>
- <param name="substituteFontNames">List of alternative font names.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.TableSubstitutionRule.AddSubstitutes(System.String,System.String[])">
- <summary>
- Adds substitute font names for given original font name.
- </summary>
- <param name="originalFontName">Original font name.</param>
- <param name="substituteFontNames">List of alternative font names.</param>
- </member>
- <member name="T:Aspose.Words.Fonts.FontFallbackSettings">
- <summary>
- Specifies font fallback mechanism settings.
- </summary>
- <remarks>
- By default fallback settings are initialized with predefined settings which mimics the Microsoft Word fallback.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fonts.FontFallbackSettings.Load(System.String)">
- <summary>
- Loads font fallback settings from XML file.
- </summary>
- <param name="fileName">Input file name.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.FontFallbackSettings.Load(System.IO.Stream)">
- <summary>
- Loads fallback settings from XML stream.
- </summary>
- <param name="stream">Input stream.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.FontFallbackSettings.LoadMsOfficeFallbackSettings">
- <summary>
- Loads predefined fallback settings which mimics the Microsoft Word fallback and uses Microsoft office fonts.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fonts.FontFallbackSettings.LoadNotoFallbackSettings">
- <summary>
- Loads predefined fallback settings which uses Google Noto fonts.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fonts.FontFallbackSettings.Save(System.IO.Stream)">
- <summary>
- Saves the current fallback settings to stream.
- </summary>
- <param name="outputStream">Output stream.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.FontFallbackSettings.Save(System.String)">
- <summary>
- Saves the current fallback settings to file.
- </summary>
- <param name="fileName">Output file name.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.FontFallbackSettings.BuildAutomatic">
- <summary>
- Automatically builds the fallback settings by scanning available fonts.
- </summary>
- <remarks>
- This method may produce non-optimal fallback settings. Fonts are checked by <a href="https://docs.microsoft.com/en-us/typography/opentype/spec/os2#ur">
- Unicode Character Range</a> fields and not by the actual glyphs presence. Also Unicode ranges are checked individually
- and several ranges related to single language/script may use different fallback fonts.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fonts.PhysicalFontInfo">
- <summary>
- Specifies information about physical font available to Aspose.Words font engine.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.PhysicalFontInfo.FontFamilyName">
- <summary>
- Family name of the font.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.PhysicalFontInfo.FullFontName">
- <summary>
- Full name of the font.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.PhysicalFontInfo.Version">
- <summary>
- Version string of the font.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.PhysicalFontInfo.FilePath">
- <summary>
- Path to the font file if any.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.EmbeddedFontFormat">
- <summary>
- <para>Specifies format of particular embedded font inside <see cref="T:Aspose.Words.Fonts.FontInfo" /> object.</para>
- <para>When saving a document to a file, only embedded fonts of corresponding format are written down.</para>
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.EmbeddedFontFormat.EmbeddedOpenType">
- <summary>
- <para>Specifies Embedded OpenType (EOT) File Format.</para>
- <para>This format of embedded fonts used in DOC files.</para>
- </summary>
- <remarks>
- <para>See http://www.w3.org/Submission/EOT for description of the format.</para>
- </remarks>
- </member>
- <member name="F:Aspose.Words.Fonts.EmbeddedFontFormat.OpenType">
- <summary>
- <para>Specifies font, embedded as plain copy of OpenType (TrueType) font file.</para>
- <para>This format of embedded fonts used in Open Office XML format, including DOCX files.</para>
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.EmbeddedFontStyle">
- <summary>
- Specifies the style of an embedded font inside a <see cref="T:Aspose.Words.Fonts.FontInfo" /> object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.EmbeddedFontStyle.Regular">
- <summary>
- Specifies the Regular embedded font.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.EmbeddedFontStyle.Bold">
- <summary>
- Specifies the Bold embedded font.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.EmbeddedFontStyle.Italic">
- <summary>
- Specifies the Italic embedded font.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.EmbeddedFontStyle.BoldItalic">
- <summary>
- Specifies the Bold-Italic embedded font.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.FileFontSource">
- <summary>
- Represents the single TrueType font file stored in the file system.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fonts.FileFontSource.#ctor(System.String)">
- <summary>
- Ctor.
- </summary>
- <param name="filePath">Path to font file.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.FileFontSource.#ctor(System.String,System.Int32)">
- <summary>
- Ctor.
- </summary>
- <param name="filePath">Path to font file.</param>
- <param name="priority">Font source priority. See the <see cref="P:Aspose.Words.Fonts.FontSourceBase.Priority" /> property description for more information.</param>
- </member>
- <member name="P:Aspose.Words.Fonts.FileFontSource.FilePath">
- <summary>
- Path to the font file.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FileFontSource.Type">
- <summary>
- Returns the type of the font source.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.FolderFontSource">
- <summary>
- Represents the folder that contains TrueType font files.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fonts.FolderFontSource.#ctor(System.String,System.Boolean)">
- <summary>
- Ctor.
- </summary>
- <param name="folderPath">Path to folder.</param>
- <param name="scanSubfolders">Determines whether or not to scan subfolders.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.FolderFontSource.#ctor(System.String,System.Boolean,System.Int32)">
- <summary>
- Ctor.
- </summary>
- <param name="folderPath">Path to folder.</param>
- <param name="scanSubfolders">Determines whether or not to scan subfolders.</param>
- <param name="priority">Font source priority. See the <see cref="P:Aspose.Words.Fonts.FontSourceBase.Priority" /> property description for more information.</param>
- </member>
- <member name="P:Aspose.Words.Fonts.FolderFontSource.FolderPath">
- <summary>
- Path to the folder.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FolderFontSource.ScanSubfolders">
- <summary>
- Determines whether or not to scan the subfolders.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FolderFontSource.Type">
- <summary>
- Returns the type of the font source.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.FontSourceBase">
- <summary>
- This is an abstract base class for the classes that allow the user to specify various font sources.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fonts.FontSourceBase.GetAvailableFonts">
- <summary>
- Returns list of fonts available via this source.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FontSourceBase.Type">
- <summary>
- Returns the type of the font source.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FontSourceBase.Priority">
- <summary>
- Returns the font source priority.
- </summary>
- <remarks>
- <para>This value is used when there are fonts with the same family name and style in different font sources.
- In this case Aspose.Words selects the font from the source with the higher priority value.</para>
- <para>The default value is 0.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fonts.FontSourceType">
- <summary>
- Specifies the type of a font source.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.FontSourceType.FontFile">
- <summary>
- A <see cref="T:Aspose.Words.Fonts.FileFontSource" /> object that represents single font file.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.FontSourceType.FontsFolder">
- <summary>
- A <see cref="T:Aspose.Words.Fonts.FolderFontSource" /> object that represents folder with font files.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.FontSourceType.MemoryFont">
- <summary>
- A <see cref="T:Aspose.Words.Fonts.MemoryFontSource" /> object that represents single font in memory.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.FontSourceType.SystemFonts">
- <summary>
- A <see cref="T:Aspose.Words.Fonts.SystemFontSource" /> object that represents all fonts installed to the system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.FontSourceType.FontStream">
- <summary>
- A <see cref="T:Aspose.Words.Fonts.StreamFontSource" /> object that represents a stream with font data.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.MemoryFontSource">
- <summary>
- Represents the single TrueType font file stored in memory.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fonts.MemoryFontSource.#ctor(System.Byte[])">
- <summary>
- Ctor.
- </summary>
- <param name="fontData">Binary font data.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.MemoryFontSource.#ctor(System.Byte[],System.Int32)">
- <summary>
- Ctor.
- </summary>
- <param name="fontData">Binary font data.</param>
- <param name="priority">Font source priority. See the <see cref="P:Aspose.Words.Fonts.FontSourceBase.Priority" /> property description for more information.</param>
- </member>
- <member name="P:Aspose.Words.Fonts.MemoryFontSource.FontData">
- <summary>
- Binary font data.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.MemoryFontSource.Type">
- <summary>
- Returns the type of the font source.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.SystemFontSource">
- <summary>
- Represents all TrueType fonts installed to the system.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fonts.SystemFontSource.#ctor">
- <summary>
- Ctor.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fonts.SystemFontSource.#ctor(System.Int32)">
- <summary>
- Ctor.
- </summary>
- <param name="priority">Font source priority. See the <see cref="P:Aspose.Words.Fonts.FontSourceBase.Priority" /> property description for more information.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.SystemFontSource.GetSystemFontFolders">
- <summary>
- Returns system font folders or empty array if folders are not accessible.
- </summary>
- <remarks>
- On some platforms Aspose.Words could search system fonts not only through folders but in other sources too. For example, on Windows platform
- Aspose.Words search fonts also in the registry.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fonts.SystemFontSource.Type">
- <summary>
- Returns the type of the font source.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.NamespaceDoc">
- <summary>
- <p>The <b>Aspose.Words.Fonts</b> namespace provides classes and enumerations to access information about
- fonts used in a document.</p>
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.FontFamily">
- <summary>
- Represents the font family.
- </summary>
- <remarks>
- <para>A font family is a set of fonts having common stroke width and serif characteristics.</para>
- </remarks>
- </member>
- <member name="F:Aspose.Words.Fonts.FontFamily.Auto">
- <summary>
- Specifies a generic family name. This name is used when information about a font
- does not exist or does not matter. The default font is used.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.FontFamily.Roman">
- <summary>
- Specifies a proportional font with serifs. An example is Times New Roman.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.FontFamily.Swiss">
- <summary>
- Specifies a proportional font without serifs. An example is Arial.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.FontFamily.Modern">
- <summary>
- Specifies a monospace font with or without serifs. Monospace fonts are
- usually modern; examples include Pica, Elite, and Courier New.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.FontFamily.Script">
- <summary>
- Specifies a font that is designed to look like handwriting; examples include Script and Cursive.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.FontFamily.Decorative">
- <summary>
- Specifies a novelty font. An example is Old English.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.FontInfoCollection">
- <summary>
- Represents a collection of fonts used in a document.
- </summary>
- <remarks>
- <para>Items are <see cref="T:Aspose.Words.Fonts.FontInfo" /> objects.</para>
- <para>You do not create instances of this class directly.
- Use the <see cref="P:Aspose.Words.DocumentBase.FontInfos" /> property to access the collection of fonts
- defined in the document.</para>
- <seealso cref="T:Aspose.Words.Fonts.FontInfo" />
- <seealso cref="P:Aspose.Words.DocumentBase.FontInfos" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fonts.FontInfoCollection.GetEnumerator">
- <summary>
- Returns an enumerator object that can be used to iterate over all items in the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fonts.FontInfoCollection.Contains(System.String)">
- <summary>
- Determines whether the collection contains a font with the given name.
- </summary>
- <param name="name">Case-insensitive name of the font to locate.</param>
- <returns>True if the item is found in the collection; otherwise, false.</returns>
- </member>
- <member name="P:Aspose.Words.Fonts.FontInfoCollection.Count">
- <summary>
- Gets the number of elements contained in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FontInfoCollection.Item(System.String)">
- <overloads>Provides access to the collection items.</overloads>
- <summary>
- Gets a font with the specified name.
- </summary>
- <param name="name">Case-insensitive name of the font to locate.</param>
- </member>
- <member name="P:Aspose.Words.Fonts.FontInfoCollection.Item(System.Int32)">
- <summary>
- Gets a font at the specified index.
- </summary>
- <param name="index">Zero-based index of the font.</param>
- </member>
- <member name="P:Aspose.Words.Fonts.FontInfoCollection.EmbedTrueTypeFonts">
- <summary>
- Specifies whether or not to embed TrueType fonts in a document when it is saved.
- Default value for this property is <b>false</b>.
- </summary>
- <remarks>
- <para>Embedding TrueType fonts allows others to view the document with the same fonts that were used to create it,
- but may substantially increase the document size.</para>
- <para>This option works for DOC, DOCX and RTF formats only.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fonts.FontInfoCollection.EmbedSystemFonts">
- <summary>
- <para>Specifies whether or not to embed System fonts into the document.
- Default value for this property is <b>false</b>.</para>
- <para>This option works only when <see cref="P:Aspose.Words.Fonts.FontInfoCollection.EmbedTrueTypeFonts" /> option is set to <b>true</b>.</para>
- </summary>
- <remarks>
- <para>
- Setting this property to <c>True</c> is useful if the user is on an East Asian system
- and wants to create a document that is readable by others who do not have fonts for that
- language on their system. For example, a user on a Japanese system could choose to embed the
- fonts in a document so that the Japanese document would be readable on all systems.
- </para>
- <para>This option works for DOC, DOCX and RTF formats only.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fonts.FontInfoCollection.SaveSubsetFonts">
- <summary>
- <para>Specifies whether or not to save a subset of the embedded TrueType fonts with the document.
- Default value for this property is <b>false</b>.</para>
- <para>This option works only when <see cref="P:Aspose.Words.Fonts.FontInfoCollection.EmbedTrueTypeFonts" /> property is set to <b>true</b>.</para>
- </summary>
- <remarks>
- This option works for DOC, DOCX and RTF formats only.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fonts.FontInfo">
- <summary>
- Specifies information about a font used in the document.
- </summary>
- <remarks>
- <para>You do not create instances of this class directly.
- Use the <see cref="P:Aspose.Words.DocumentBase.FontInfos" /> property to access the collection of fonts
- defined in a document.</para>
- <seealso cref="T:Aspose.Words.Fonts.FontInfoCollection" />
- <seealso cref="P:Aspose.Words.DocumentBase.FontInfos" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fonts.FontInfo.GetEmbeddedFont(Aspose.Words.Fonts.EmbeddedFontFormat,Aspose.Words.Fonts.EmbeddedFontStyle)">
- <summary>
- Gets a specific embedded font file.
- </summary>
- <param name="format">Specifies the font format to retrieve.</param>
- <param name="style">Specifies the font style to retrieve.</param>
- <returns>Returns <c>null</c> if the specified font is not embedded.</returns>
- </member>
- <member name="M:Aspose.Words.Fonts.FontInfo.GetEmbeddedFontAsOpenType(Aspose.Words.Fonts.EmbeddedFontStyle)">
- <summary>
- Gets an embedded font file in OpenType format. Fonts in Embedded OpenType format are converted to OpenType.
- </summary>
- <param name="style">Specifies the font style to retrieve.</param>
- <returns>Returns <c>null</c> if the specified font is not embedded.</returns>
- </member>
- <member name="P:Aspose.Words.Fonts.FontInfo.Pitch">
- <summary>
- The pitch indicates if the font is fixed pitch, proportionally spaced, or relies on a default setting.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FontInfo.IsTrueType">
- <summary>
- Indicates that this font is a TrueType or OpenType font as opposed to a raster or vector font.
- Default is true.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FontInfo.Family">
- <summary>
- Gets or sets the font family this font belongs to.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FontInfo.Charset">
- <summary>
- Gets or sets the character set for the font.
- </summary>
- <dev>
- Such charset code is replaced by IANA name of character set in ISO/IEC 29500.
- We may not know charset codes for some IANA charset names. Also there may be unknown charset codes.
- For example AW test documents contain the undocumented 0x4E and 0x50 codes.
- So, now we store the both: charset codes and charset IANA names to be able to write charset as it was read.
- </dev>
- </member>
- <member name="P:Aspose.Words.Fonts.FontInfo.Panose">
- <summary>
- Gets or sets the PANOSE typeface classification number.
- </summary>
- <remarks>
- <para>PANOSE is a compact 10-byte description of a fonts critical visual characteristics,
- such as contrast, weight, and serif style. The digits represent Family Kind, Serif Style,
- Weight, Proportion, Contrast, Stroke Variation, Arm Style, Letterform, Midline, and X-Height.</para>
- <para>Can be <c>null</c>.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fonts.FontInfo.Name">
- <summary>
- Gets the name of the font.
- </summary>
- <remarks>
- <para>Cannot be <c>null</c>. Can be an empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fonts.FontInfo.AltName">
- <summary>
- Gets or sets the alternate name for the font.
- </summary>
- <remarks>
- <para>Cannot be <c>null</c>. Can be an empty string.</para>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fonts.FontPitch">
- <summary>
- Represents the font pitch.
- </summary>
- <remarks>The pitch indicates if the font is fixed pitch, proportionally spaced, or relies on a default setting.</remarks>
- </member>
- <member name="F:Aspose.Words.Fonts.FontPitch.Default">
- <summary>
- Specifies that no information is available about the pitch of a font.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.FontPitch.Fixed">
- <summary>
- Specifies that this is a fixed width font.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fonts.FontPitch.Variable">
- <summary>
- Specifies that this is a proportional width font.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fonts.FontSettings">
- <summary>
- Specifies font settings for a document.
- </summary>
- <remarks>
- <para>Aspose.Words uses font settings to resolve the fonts in the document. Fonts are resolved mostly when building document layout
- or rendering to fixed page formats. But when loading some formats, Aspose.Words also may require to resolve the fonts. For example, when
- loading HTML documents Aspose.Words may resolve the fonts to perform font fallback. So it is recommended that you set the font settings in
- <see cref="T:Aspose.Words.LoadOptions" /> when loading the document. Or at least before building the layout or rendering the document to the fixed-page format.</para>
- <para>By default all documents uses single static font settings instance. It could be accessed by
- <see cref="P:Aspose.Words.Fonts.FontSettings.DefaultInstance" /> property.</para>
- <para>Changing font settings is safe at any time from any thread. But it is recommended that you do not change the font settings while
- processing some documents which uses this settings. This can lead to the fact that the same font will be resolved differently
- in different parts of the document.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fonts.FontSettings.SetFontsFolder(System.String,System.Boolean)">
- <summary>
- Sets the folder where Aspose.Words looks for TrueType fonts when rendering documents or embedding fonts.
- This is a shortcut to <see cref="M:Aspose.Words.Fonts.FontSettings.SetFontsFolders(System.String[],System.Boolean)" /> for setting only one font directory.
- </summary>
- <param name="fontFolder">The folder that contains TrueType fonts.</param>
- <param name="recursive">True to scan the specified folders for fonts recursively.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.FontSettings.SetFontsFolders(System.String[],System.Boolean)">
- <summary>
- Sets the folders where Aspose.Words looks for TrueType fonts when rendering documents or embedding fonts.
- </summary>
- <remarks>
- <para>By default, Aspose.Words looks for fonts installed to the system.</para>
- <para>Setting this property resets the cache of all previously loaded fonts.</para>
- </remarks>
- <param name="fontsFolders">An array of folders that contain TrueType fonts.</param>
- <param name="recursive">True to scan the specified folders for fonts recursively.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.FontSettings.SetFontsSources(Aspose.Words.Fonts.FontSourceBase[])">
- <summary>
- Sets the sources where Aspose.Words looks for TrueType fonts when rendering documents or embedding fonts.
- </summary>
- <remarks>
- <para>By default, Aspose.Words looks for fonts installed to the system.</para>
- <para>Setting this property resets the cache of all previously loaded fonts.</para>
- </remarks>
- <param name="sources">An array of sources that contain TrueType fonts.</param>
- </member>
- <member name="M:Aspose.Words.Fonts.FontSettings.GetFontsSources">
- <summary>
- Gets a copy of the array that contains the list of sources where Aspose.Words looks for TrueType fonts.
- </summary>
- <remarks>
- <para>The returned value is a copy of the data that Aspose.Words uses. If you change the entries
- in the returned array, it will have no effect on document rendering. To specify new font sources
- use the <see cref="M:Aspose.Words.Fonts.FontSettings.SetFontsSources(Aspose.Words.Fonts.FontSourceBase[])" /> method.</para>
- </remarks>
- <returns>A copy of the current font sources.</returns>
- </member>
- <member name="M:Aspose.Words.Fonts.FontSettings.ResetFontSources">
- <summary>
- Resets the fonts sources to the system default.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FontSettings.DefaultInstance">
- <summary>
- Static default font settings.
- </summary>
- <remarks>
- This instance is used by default in a document unless <see cref="P:Aspose.Words.Document.FontSettings" /> is specified.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fonts.FontSettings.FallbackSettings">
- <summary>
- Settings related to font fallback mechanism.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fonts.FontSettings.SubstitutionSettings">
- <summary>
- Settings related to font substitution mechanism.
- </summary>
- </member>
- <member name="T:Aspose.Words.Replacing.NamespaceDoc">
- <summary>
- <p>The <b>Aspose.Words.Replacing</b> namespace provides classes to manipulate
- with find/replace operations over the document tree.</p>
- </summary>
- </member>
- <member name="T:Aspose.Words.Replacing.FindReplaceOptions">
- <summary>
- Specifies options for find/replace operations.
- </summary>
- </member>
- <member name="P:Aspose.Words.Replacing.FindReplaceOptions.ApplyFont">
- <summary>
- Text formatting applied to new content.
- </summary>
- </member>
- <member name="P:Aspose.Words.Replacing.FindReplaceOptions.ApplyParagraphFormat">
- <summary>
- Paragraph formatting applied to new content.
- </summary>
- </member>
- <member name="P:Aspose.Words.Replacing.FindReplaceOptions.Direction">
- <summary>
- Selects direction for replace. Default value is <see cref="F:Aspose.Words.FindReplaceDirection.Forward" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Replacing.FindReplaceOptions.MatchCase">
- <summary>
- True indicates case-sensitive comparison, false indicates case-insensitive comparison.
- </summary>
- </member>
- <member name="P:Aspose.Words.Replacing.FindReplaceOptions.FindWholeWordsOnly">
- <summary>
- True indicates the oldValue must be a standalone word.
- </summary>
- </member>
- <member name="P:Aspose.Words.Replacing.FindReplaceOptions.ReplacingCallback">
- <summary>
- The user-defined method which is called before every replace occurrence.
- </summary>
- </member>
- <member name="P:Aspose.Words.Replacing.FindReplaceOptions.UseLegacyOrder">
- <summary>
- True indicates that a text search is performed sequentially from top to bottom considering the text boxes.
- Default value is false.
- </summary>
- <dev>
- FIX 19357. Added option.
- </dev>
- </member>
- <member name="P:Aspose.Words.Replacing.FindReplaceOptions.IgnoreDeleted">
- <summary>
- Gets or sets a boolean value indicating either to ignore text inside delete revisions.
- The default value is <c>false</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Replacing.FindReplaceOptions.IgnoreInserted">
- <summary>
- Gets or sets a boolean value indicating either to ignore text inside insert revisions.
- The default value is <c>false</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Replacing.FindReplaceOptions.IgnoreFields">
- <summary>
- Gets or sets a boolean value indicating either to ignore text inside fields.
- The default value is <c>false</c>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Replacing.FindReplaceOptions.UseSubstitutions">
- <summary>
- Gets or sets a boolean value indicating whether to recognize and use substitutions within replacement patterns.
- The default value is <c>false</c>.
- </summary>
- <remarks>
- For the details on substitution elements please refer to:
- https://docs.microsoft.com/en-us/dotnet/standard/base-types/substitutions-in-regular-expressions.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Replacing.FindReplaceOptions.LegacyMode">
- <summary>
- Gets or sets a boolean value indicating that old find/replace algorithm is used.
- </summary>
- <remarks>
- Use this flag if you need exactly the same behavior as before advanced find/replace feature was introduced.
- Note that old algorithm does not support advanced features such as replace with breaks, apply formatting and so on.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Replacing.ReplaceAction">
- <summary>
- Allows the user to specify what happens to the current match during a replace operation.
- </summary>
- <seealso cref="T:Aspose.Words.Replacing.IReplacingCallback" />
- <seealso cref="T:Aspose.Words.Range" />
- <seealso cref="M:Aspose.Words.Range.Replace(System.String,System.String,Aspose.Words.Replacing.FindReplaceOptions)" />
- </member>
- <member name="F:Aspose.Words.Replacing.ReplaceAction.Replace">
- <summary>
- Replace the current match.
- </summary>
- </member>
- <member name="F:Aspose.Words.Replacing.ReplaceAction.Skip">
- <summary>
- Skip the current match.
- </summary>
- </member>
- <member name="F:Aspose.Words.Replacing.ReplaceAction.Stop">
- <summary>
- Terminate the replace operation.
- </summary>
- </member>
- <member name="T:Aspose.Words.Replacing.IReplacingCallback">
- <summary>
- Implement this interface if you want to have your own custom method called during a find and replace operation.
- </summary>
- </member>
- <member name="M:Aspose.Words.Replacing.IReplacingCallback.Replacing(Aspose.Words.Replacing.ReplacingArgs)">
- <summary>
- A user defined method that is called during a replace operation for each match found just before a replace is made.
- </summary>
- <returns>
- A <see cref="T:Aspose.Words.Replacing.ReplaceAction" /> value that specifies the action to be taken for the current match.
- </returns>
- </member>
- <member name="T:Aspose.Words.Replacing.ReplacingArgs">
- <summary>
- Provides data for a custom replace operation.
- </summary>
- <seealso cref="T:Aspose.Words.Replacing.IReplacingCallback" />
- <seealso cref="T:Aspose.Words.Range" />
- <seealso cref="M:Aspose.Words.Range.Replace(System.String,System.String,Aspose.Words.Replacing.FindReplaceOptions)" />
- </member>
- <member name="P:Aspose.Words.Replacing.ReplacingArgs.Match">
- <summary>
- The <see cref="T:System.Text.RegularExpressions.Match" /> resulting from a single regular
- expression match during a <b>Replace</b>.
- </summary>
- <remarks>
- <p>
- <b>Match.Index"</b> gets the zero-based starting
- position of the match from the start of the find and replace range.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Replacing.ReplacingArgs.MatchNode">
- <summary>
- Gets the node that contains the beginning of the match.
- </summary>
- </member>
- <member name="P:Aspose.Words.Replacing.ReplacingArgs.MatchOffset">
- <summary>
- Gets the zero-based starting position of the match from the start of
- the node that contains the beginning of the match.
- </summary>
- </member>
- <member name="P:Aspose.Words.Replacing.ReplacingArgs.Replacement">
- <summary>
- Gets or sets the replacement string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Replacing.ReplacingArgs.GroupName">
- <summary>
- Identifies, by name, a captured group in the <see cref="P:Aspose.Words.Replacing.ReplacingArgs.Match" />
- that is to be replaced with the <see cref="P:Aspose.Words.Replacing.ReplacingArgs.Replacement" /> string.
- </summary>
- <remarks>
- <p>When group name is null, <see cref="P:Aspose.Words.Replacing.ReplacingArgs.GroupIndex" /> is used to identify the group.</p>
- <p>Default is null.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Replacing.ReplacingArgs.GroupIndex">
- <summary>
- Identifies, by index, a captured group in the <see cref="P:Aspose.Words.Replacing.ReplacingArgs.Match" />
- that is to be replaced with the <see cref="P:Aspose.Words.Replacing.ReplacingArgs.Replacement" /> string.
- </summary>
- <remarks>
- <p>
- <see cref="P:Aspose.Words.Replacing.ReplacingArgs.GroupIndex" /> has effect only when <see cref="P:Aspose.Words.Replacing.ReplacingArgs.GroupName" /> is null.</p>
- <p>Default is zero.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldIndexFormat">
- <summary>
- Specifies the formatting for the <see cref="T:Aspose.Words.Fields.FieldIndex" /> fields in a document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldIndexFormat.Template">
- <summary>From template.</summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldIndexFormat.Classic">
- <summary>Classic.</summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldIndexFormat.Fancy">
- <summary>Fancy.</summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldIndexFormat.Modern">
- <summary>Modern.</summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldIndexFormat.Bulleted">
- <summary>Bulleted.</summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldIndexFormat.Formal">
- <summary>Formal.</summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldIndexFormat.Simple">
- <summary>Simple.</summary>
- </member>
- <member name="T:Aspose.Words.Fields.IFieldUpdateCultureProvider">
- <summary>
- When implemented, provides a <see cref="T:System.Globalization.CultureInfo" /> object that should be used during the update of a particular field.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fields.IFieldUpdateCultureProvider.GetCulture(System.String,Aspose.Words.Fields.Field)">
- <summary>
- Returns a <see cref="T:System.Globalization.CultureInfo" /> object to be used during the field's update.
- </summary>
- <param name="culture">The name of the culture requested for the field being updated.</param>
- <param name="field">The field being updated.</param>
- <returns>The culture object that should be used for the field's update.</returns>
- </member>
- <member name="T:Aspose.Words.Fields.FieldIfComparisonResult">
- <summary>
- Specifies the result of the IF field condition evaluation.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldIfComparisonResult.Error">
- <summary>
- There is an error in the condition.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldIfComparisonResult.True">
- <summary>
- The condition is <c>true</c>.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldIfComparisonResult.False">
- <summary>
- The condition is <c>false</c>.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.ToaCategories">
- <summary>
- Represents a table of authorities categories.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.ToaCategories.DefaultCategories">
- <summary>
- Gets the default table of authorities categories.
- </summary>
- <remarks>
- Use the <see cref="P:Aspose.Words.Fields.FieldOptions.ToaCategories" /> property to specify table of authorities categories for a single document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.ToaCategories.Item(System.Int32)">
- <summary>
- Gets or sets the category heading by category number.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.IFieldResultFormatter">
- <summary>
- Implement this interface if you want to control how the field result is formatted.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fields.IFieldResultFormatter.FormatNumeric(System.Double,System.String)">
- <summary>
- Called when Aspose.Words applies a numeric format switch, i.e. \# "#.##".
- </summary>
- <remarks>
- The implementation should return <b>null</b> to indicate that the default formatting should be applied.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.IFieldResultFormatter.FormatDateTime(System.DateTime,System.String,Aspose.Words.CalendarType)">
- <summary>
- Called when Aspose.Words applies a date/time format switch, i.e. \@ "dd.MM.yyyy".
- </summary>
- <remarks>
- The implementation should return <b>null</b> to indicate that the default formatting should be applied.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.IFieldResultFormatter.Format(System.String,Aspose.Words.Fields.GeneralFormat)">
- <summary>
- Called when Aspose.Words applies a capitalization format switch, i.e. \* Upper.
- </summary>
- <remarks>
- The implementation should return <b>null</b> to indicate that the default formatting should be applied.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.IFieldResultFormatter.Format(System.Double,Aspose.Words.Fields.GeneralFormat)">
- <summary>
- Called when Aspose.Words applies a number format switch, i.e. \* Ordinal.
- </summary>
- <remarks>
- The implementation should return <b>null</b> to indicate that the default formatting should be applied.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.UserInformation">
- <summary>
- Specifies information about the user.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.UserInformation.Name">
- <summary>
- Gets or sets the user's name.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.UserInformation.Initials">
- <summary>
- Gets or sets the user's initials.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.UserInformation.Address">
- <summary>
- Gets or sets the user's postal address.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.UserInformation.DefaultUser">
- <summary>
- Default user information.
- </summary>
- <remarks>
- Use the <see cref="P:Aspose.Words.Fields.FieldOptions.CurrentUser" /> property to specify user information for single document.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldArgumentBuilder">
- <summary>
- Builds a complex field argument consisting of fields, nodes, and plain text.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fields.FieldArgumentBuilder.#ctor">
- <summary>
- Initializes an instance of the <see cref="T:Aspose.Words.Fields.FieldArgumentBuilder" /> class.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fields.FieldArgumentBuilder.AddText(System.String)">
- <summary>
- Adds a plain text to the argument.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fields.FieldArgumentBuilder.AddNode(Aspose.Words.Inline)">
- <summary>
- Adds a node to the argument.
- </summary>
- <remarks>
- Only text level nodes are supported at the moment.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.FieldArgumentBuilder.AddField(Aspose.Words.Fields.FieldBuilder)">
- <summary>
- Adds a field represented by a <see cref="T:Aspose.Words.Fields.FieldBuilder" /> to the argument.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldBuilder">
- <summary>
- Builds a field from field code tokens (arguments and switches).
- </summary>
- </member>
- <member name="M:Aspose.Words.Fields.FieldBuilder.#ctor(Aspose.Words.Fields.FieldType)">
- <summary>
- Initializes an instance of the <see cref="T:Aspose.Words.Fields.FieldBuilder" /> class.
- </summary>
- <param name="fieldType">The type of the field to build.</param>
- </member>
- <member name="M:Aspose.Words.Fields.FieldBuilder.AddArgument(System.String)">
- <summary>
- Adds a field's argument.
- </summary>
- <param name="argument">The argument value.</param>
- </member>
- <member name="M:Aspose.Words.Fields.FieldBuilder.AddArgument(System.Int32)">
- <summary>
- Adds a field's argument.
- </summary>
- <param name="argument">The argument value.</param>
- </member>
- <member name="M:Aspose.Words.Fields.FieldBuilder.AddArgument(System.Double)">
- <summary>
- Adds a field's argument.
- </summary>
- <param name="argument">The argument value.</param>
- </member>
- <member name="M:Aspose.Words.Fields.FieldBuilder.AddArgument(Aspose.Words.Fields.FieldBuilder)">
- <summary>
- Adds a child field represented by another <see cref="T:Aspose.Words.Fields.FieldBuilder" /> to the field's code.
- </summary>
- <remarks>
- This overload is used when the argument consists of a single child field.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.FieldBuilder.AddArgument(Aspose.Words.Fields.FieldArgumentBuilder)">
- <summary>
- Adds a field's argument represented by <see cref="T:Aspose.Words.Fields.FieldArgumentBuilder" /> to the field's code.
- </summary>
- <remarks>
- This overload is used when the argument consists of a mixture of different parts such as child fields, nodes, and plain text.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.FieldBuilder.AddSwitch(System.String)">
- <summary>
- Adds a field's switch.
- </summary>
- <remarks>
- This overload adds a flag (switch without argument).
- </remarks>
- <param name="switchName">The switch name.</param>
- </member>
- <member name="M:Aspose.Words.Fields.FieldBuilder.AddSwitch(System.String,System.String)">
- <summary>
- Adds a field's switch.
- </summary>
- <param name="switchName">The switch name.</param>
- <param name="switchArgument">The switch value.</param>
- </member>
- <member name="M:Aspose.Words.Fields.FieldBuilder.AddSwitch(System.String,System.Int32)">
- <summary>
- Adds a field's switch.
- </summary>
- <param name="switchName">The switch name.</param>
- <param name="switchArgument">The switch value.</param>
- </member>
- <member name="M:Aspose.Words.Fields.FieldBuilder.AddSwitch(System.String,System.Double)">
- <summary>
- Adds a field's switch.
- </summary>
- <param name="switchName">The switch name.</param>
- <param name="switchArgument">The switch value.</param>
- </member>
- <member name="M:Aspose.Words.Fields.FieldBuilder.BuildAndInsert(Aspose.Words.Inline)">
- <summary>
- Builds and inserts a field into the document before the specified inline node.
- </summary>
- <returns>A <see cref="T:Aspose.Words.Fields.Field" /> object that represents the inserted field.</returns>
- </member>
- <member name="M:Aspose.Words.Fields.FieldBuilder.BuildAndInsert(Aspose.Words.Paragraph)">
- <summary>
- Builds and inserts a field into the document to the end of the specified paragraph.
- </summary>
- <returns>A <see cref="T:Aspose.Words.Fields.Field" /> object that represents the inserted field.</returns>
- </member>
- <member name="T:Aspose.Words.Fields.FieldUnknown">
- <summary>
- Implements an unknown or unrecognized field.
- </summary>
- <dev>
- Such fields are normally treated as references to bookmarks.
- </dev>
- </member>
- <member name="T:Aspose.Words.Fields.BarcodeParameters">
- <summary>
- Container class for barcode parameters to pass-through to BarcodeGenerator.
- </summary>
- <remarks>
- The set of parameters are according to DISPLAYBARCODE field options.
- See the exact list at <a href="https://msdn.microsoft.com/en-us/library/hh745901(v=office.12).aspx" /></remarks>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.BarcodeType">
- <summary>
- Bar code type.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.BarcodeValue">
- <summary>
- Data to be encoded.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.SymbolHeight">
- <summary>
- Bar code image height (in twips - 1/1440 inches)
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.ForegroundColor">
- <summary>
- Bar code foreground color (0x000000 - 0xFFFFFF)
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.BackgroundColor">
- <summary>
- Bar code background color (0x000000 - 0xFFFFFF)
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.SymbolRotation">
- <summary>
- Rotation of the barcode symbol. Valid values are [0, 3].
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.ScalingFactor">
- <summary>
- Scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000].
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.PosCodeStyle">
- <summary>
- Style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8). The valid values (case insensitive) are [STD|SUP2|SUP5|CASE].
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.CaseCodeStyle">
- <summary>
- Style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD]
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.ErrorCorrectionLevel">
- <summary>
- Error correction level of QR Code. Valid values are [0, 3].
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.DisplayText">
- <summary>
- Whether to display barcode data (text) along with image.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.AddStartStopChar">
- <summary>
- Whether to add Start/Stop characters for barcode types NW7 and CODE39.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.FixCheckDigit">
- <summary>
- Whether to fix the check digit if it’s invalid.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.PostalAddress">
- <summary>
- Barcode postal address.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.IsBookmark">
- <summary>
- Whether <see cref="P:Aspose.Words.Fields.BarcodeParameters.PostalAddress" /> is the name of a bookmark.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.FacingIdentificationMark">
- <summary>
- Type of a Facing Identification Mark (FIM).
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.BarcodeParameters.IsUSPostalAddress">
- <summary>
- Whether <see cref="P:Aspose.Words.Fields.BarcodeParameters.PostalAddress" /> is a U.S. postal address.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldMergeBarcode">
- <summary>
- Implements the MERGEBARCODE field.
- </summary>
- <remarks>
- Mail merge a barcode.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeBarcode.BarcodeValue">
- <summary>
- Gets or sets the barcode value.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeBarcode.BarcodeType">
- <summary>
- Gets or sets the barcode type (QR, etc.)
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeBarcode.SymbolHeight">
- <summary>
- Gets or sets the height of the symbol. The units are in TWIPS (1/1440 inch).
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeBarcode.SymbolRotation">
- <summary>
- Gets or sets the rotation of the barcode symbol. Valid values are [0, 3]
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeBarcode.ScalingFactor">
- <summary>
- Gets or sets a scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000]
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeBarcode.ForegroundColor">
- <summary>
- Gets or sets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeBarcode.BackgroundColor">
- <summary>
- Gets or sets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeBarcode.PosCodeStyle">
- <summary>
- Gets or sets the style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8). The valid values (case insensitive) are [STD|SUP2|SUP5|CASE].
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeBarcode.CaseCodeStyle">
- <summary>
- Gets or sets the style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD]
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeBarcode.ErrorCorrectionLevel">
- <summary>
- Gets or sets an error correction level of QR Code. Valid values are [0, 3].
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeBarcode.DisplayText">
- <summary>
- Gets or sets whether to display barcode data (text) along with image.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeBarcode.AddStartStopChar">
- <summary>
- Gets or sets whether to add Start/Stop characters for barcode types NW7 and CODE39.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeBarcode.FixCheckDigit">
- <summary>
- Gets or sets whether to fix the check digit if it’s invalid.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldDisplayBarcode">
- <summary>
- Implements the DISPLAYBARCODE field.
- </summary>
- <remarks>
- Inserts a barcode.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDisplayBarcode.BarcodeValue">
- <summary>
- Gets or sets the barcode value.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDisplayBarcode.BarcodeType">
- <summary>
- Gets or sets the barcode type (QR, etc.)
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDisplayBarcode.SymbolHeight">
- <summary>
- Gets or sets the height of the symbol. The units are in TWIPS (1/1440 inch).
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDisplayBarcode.SymbolRotation">
- <summary>
- Gets or sets the rotation of the barcode symbol. Valid values are [0, 3]
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDisplayBarcode.ScalingFactor">
- <summary>
- Gets or sets a scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000]
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDisplayBarcode.ForegroundColor">
- <summary>
- Gets or sets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDisplayBarcode.BackgroundColor">
- <summary>
- Gets or sets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDisplayBarcode.PosCodeStyle">
- <summary>
- Gets or sets the style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8). The valid values (case insensitive) are [STD|SUP2|SUP5|CASE].
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDisplayBarcode.CaseCodeStyle">
- <summary>
- Gets or sets the style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD]
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDisplayBarcode.ErrorCorrectionLevel">
- <summary>
- Gets or sets an error correction level of QR Code. Valid values are [0, 3].
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDisplayBarcode.DisplayText">
- <summary>
- Gets or sets whether to display barcode data (text) along with image.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDisplayBarcode.AddStartStopChar">
- <summary>
- Gets or sets whether to add Start/Stop characters for barcode types NW7 and CODE39.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDisplayBarcode.FixCheckDigit">
- <summary>
- Gets or sets whether to fix the check digit if it’s invalid.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.IBarcodeGenerator">
- <summary>
- Public interface for barcode custom generator. Implementation should be provided by user.
- </summary>
- <remarks>
- Generator instance should be passed through the <see cref="P:Aspose.Words.Fields.FieldOptions.BarcodeGenerator" /> property.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.IBarcodeGenerator.GetBarcodeImage(Aspose.Words.Fields.BarcodeParameters)">
- <summary>
- Generate barcode image using the set of parameters (for DisplayBarcode field).
- </summary>
- <param name="parameters">The set of parameters</param>
- <returns>Image representing generated barcode.</returns>
- </member>
- <member name="M:Aspose.Words.Fields.IBarcodeGenerator.GetOldBarcodeImage(Aspose.Words.Fields.BarcodeParameters)">
- <summary>
- Generate barcode image using the set of parameters (for old-fashioned Barcode field).
- </summary>
- <param name="parameters">The set of parameters</param>
- <returns>Image representing generated barcode.</returns>
- </member>
- <member name="T:Aspose.Words.Fields.FieldCollection">
- <summary>
- A collection of <see cref="T:Aspose.Words.Fields.Field" /> objects that represents the fields in the specified range.
- </summary>
- <remarks>
- <p>An instance of this collection iterates fields which start fall within the specified range.</p>
- <p>The <see cref="T:Aspose.Words.Fields.FieldCollection" /> collection does not own the fields it contains, rather, is just a selection of fields.</p>
- <p>The <see cref="T:Aspose.Words.Fields.FieldCollection" /> collection is "live", i.e. changes to the children of the node object
- that it was created from are immediately reflected in the fields returned by the <see cref="T:Aspose.Words.Fields.FieldCollection" />
- properties and methods.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.FieldCollection.Remove(Aspose.Words.Fields.Field)">
- <summary>
- Removes the specified field from this collection and from the document.
- </summary>
- <param name="field">A field to remove.</param>
- </member>
- <member name="M:Aspose.Words.Fields.FieldCollection.RemoveAt(System.Int32)">
- <summary>
- Removes a field at the specified index from this collection and from the document.
- </summary>
- <param name="index">An index into the collection.</param>
- </member>
- <member name="M:Aspose.Words.Fields.FieldCollection.Remove(Aspose.Words.Fields.FieldStart)">
- <summary>
- Removes the whole field by the specified field start.
- </summary>
- <param name="fieldStart">
- </param>
- </member>
- <member name="M:Aspose.Words.Fields.FieldCollection.Clear">
- <summary>
- Removes all fields of this collection from the document and from this collection itself.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fields.FieldCollection.GetEnumerator">
- <summary>
- Returns an enumerator object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCollection.Count">
- <summary>
- Returns the number of the fields in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCollection.Item(System.Int32)">
- <summary>
- Returns a field at the specified index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the collection.</param>
- </member>
- <member name="T:Aspose.Words.Fields.FieldPrint">
- <summary>
- Implements the PRINT field.
- </summary>
- <remarks>
- An instruction to send the printer-specific control code characters to the selected printer
- when the document is printed.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldPrint.PrinterInstructions">
- <summary>
- Gets or sets the printer-specific control code characters or PostScript instructions.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldPrint.PostScriptGroup">
- <summary>
- Gets or sets the drawing rectangle that the PostScript instructions operate on.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldPrivate">
- <summary>
- Implements the PRIVATE field.
- </summary>
- <remarks>
- Provides a private storage area. This field is used to store data for documents converted from other
- file formats.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldAdvance">
- <summary>
- Implements the ADVANCE field.
- </summary>
- <remarks>
- Moves the starting point at which the text that lexically follows the field is displayed to the right or left,
- up or down, or to a specific horizontal or vertical position.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAdvance.DownOffset">
- <summary>
- Gets or sets the number of points by which the text that follows the field should be moved down.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAdvance.LeftOffset">
- <summary>
- Gets or sets the number of points by which the text that follows the field should be moved left.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAdvance.RightOffset">
- <summary>
- Gets or sets the number of points by which the text that follows the field should be moved right.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAdvance.UpOffset">
- <summary>
- Gets or sets the number of points by which the text that follows the field should be moved up.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAdvance.HorizontalPosition">
- <summary>
- Gets or sets the number of points by which the text that follows the field should be moved horizontally
- from the left edge of the column, frame, or text box.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAdvance.VerticalPosition">
- <summary>
- Gets or sets the number of points by which the text that follows the field should be moved vertically
- from the top edge of the page.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldFormCheckBox">
- <summary>
- Implements the FORMCHECKBOX field.
- </summary>
- <remarks>
- Inserts a check box style form field.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldFormDropDown">
- <summary>
- Implements the FORMDROPDOWN field.
- </summary>
- <remarks>
- Inserts a drop-down list style form field.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldIndex">
- <summary>
- Implements the INDEX field.
- </summary>
- <remarks>
- Builds an index using the index entries specified by XE fields, and inserts that index at this place in the document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.BookmarkName">
- <summary>
- Gets or sets the name of the bookmark that marks the portion of the document used to build the index.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.NumberOfColumns">
- <summary>
- Gets or sets the number of columns per page used when building the index.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.SequenceSeparator">
- <summary>
- Gets or sets the character sequence that is used to separate sequence numbers and page numbers.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.PageNumberSeparator">
- <summary>
- Gets or sets the character sequence that is used to separate an index entry and its page number.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.HasPageNumberSeparator">
- <summary>
- Gets a value indicating whether a page number separator is overridden through the field's code.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.EntryType">
- <summary>
- Gets or sets an index entry type used to build the index.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.PageRangeSeparator">
- <summary>
- Gets or sets the character sequence that is used to separate the start and end of a page range.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.Heading">
- <summary>
- Gets or sets a heading that appears at the start of each set of entries for any given letter.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.CrossReferenceSeparator">
- <summary>
- Gets or sets the character sequence that is used to separate cross references and other entries.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.PageNumberListSeparator">
- <summary>
- Gets or sets the character sequence that is used to separate two page numbers in a page number list.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.LetterRange">
- <summary>
- Gets or sets a range of letters to which limit the index.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.RunSubentriesOnSameLine">
- <summary>
- Gets or sets whether run subentries into the same line as the main entry.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.SequenceName">
- <summary>
- Gets or sets the name of a sequence whose number is included with the page number.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.HasSequenceName">
- <summary>
- Gets a value indicating whether a sequence should be used while the field's result building.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.UseYomi">
- <summary>
- Gets or sets whether to enable the use of yomi text for index entries.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIndex.LanguageId">
- <summary>
- Gets or sets the language ID used to generate the index.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldRD">
- <summary>
- Implements the RD field.
- </summary>
- <remarks>
- Identifies a file to include when you create a table of contents, a table of authorities, or an index
- with the TOC, TOA, or INDEX field
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldRD.FileName">
- <summary>
- Gets or sets the name of the file to include when generating a table of contents, table of authorities, or index.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldRD.IsPathRelative">
- <summary>
- Gets or sets whether the path is relative to the current document.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldTA">
- <summary>
- Implements the TA field.
- </summary>
- <remarks>
- Defines the text and page number for a table of authorities entry, which is used by a TOA field.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldTA.IsBold">
- <summary>
- Gets or sets whether to apply bold formatting to the page number for the entry.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldTA.EntryCategory">
- <summary>
- Gets or sets the integral entry category, which is a number that corresponds to the order of
- categories.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldTA.IsItalic">
- <summary>
- Gets or sets whether to apply italic formatting to the page number for the entry.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldTA.LongCitation">
- <summary>
- Gets or sets the long citation for the entry.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldTA.PageRangeBookmarkName">
- <summary>
- Gets or sets the name of the bookmark that marks a range of pages that is inserted as the entry's page number.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldTA.ShortCitation">
- <summary>
- Gets or sets the short citation for the entry.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldToa">
- <summary>
- Implements the TOA field.
- </summary>
- <remarks>
- Builds a table of authorities (that is, a list of the references in a legal document, such as references
- to cases, statutes, and rules, along with the numbers of the pages on which the references appear) using the
- entries specified by TA fields.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToa.BookmarkName">
- <summary>
- Gets or sets the name of the bookmark that marks the portion of the document used to build the table.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToa.EntryCategory">
- <summary>
- Gets or sets the integral category for entries included in the table.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToa.SequenceSeparator">
- <summary>
- Gets or sets the character sequence that is used to separate sequence numbers and page numbers.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToa.EntrySeparator">
- <summary>
- Gets or sets the character sequence that is used to separate a table of authorities entry and its page number.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToa.RemoveEntryFormatting">
- <summary>
- Gets or sets whether to remove the formatting of the entry text in the document from the
- entry in the table of authorities.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToa.PageRangeSeparator">
- <summary>
- Gets or sets the character sequence that is used to separate the start and end of a page range.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToa.UseHeading">
- <summary>
- Gets or sets whether to include the category heading for the entries in a table of authorities.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToa.PageNumberListSeparator">
- <summary>
- Gets or sets the character sequence that is used to separate two page numbers in a page number list.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToa.UsePassim">
- <summary>
- Gets or sets whether to replace five or more different page references to the same
- authority with "passim", which is used to indicate that a word or passage occurs frequently
- in the work cited.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToa.SequenceName">
- <summary>
- Gets or sets the name of a sequence whose number is included with the page number.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldAsk">
- <summary>
- Implements the ASK field.
- </summary>
- <remarks>
- Prompts the user to enter information and assigns a bookmark to represent the user's response.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAsk.BookmarkName">
- <summary>
- Gets or sets the name of the bookmark.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAsk.PromptText">
- <summary>
- Gets or sets the prompt text (the title of the prompt window).
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAsk.DefaultResponse">
- <summary>
- Gets or sets default user response (initial value contained in the prompt window).
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAsk.PromptOnceOnMailMerge">
- <summary>
- Gets or sets whether the user response should be recieved once per a mail merge operation.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldAutoText">
- <summary>
- Implements the AUTOTEXT field.
- </summary>
- <remarks>
- Inserts an AutoText entry.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAutoText.EntryName">
- <summary>
- Gets or sets the name of the AutoText entry.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldAutoTextList">
- <summary>
- Implements the AUTOTEXTLIST field.
- </summary>
- <remarks>
- Creates a shortcut menu based on AutoText entries in the active template.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAutoTextList.EntryName">
- <summary>
- Gets or sets the name of the AutoText entry.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAutoTextList.ListStyle">
- <summary>
- Gets or sets the name of the style on which the list to contain entries is based.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAutoTextList.ScreenTip">
- <summary>
- Gets or sets the text of the ScreenTip to show.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldBibliography">
- <summary>
- Implements the BIBLIOGRAPHY field.
- </summary>
- <remarks>Inserts the contents of the document's Bibliography part in a bibliographic style.</remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldBibliography.FormatLanguageId">
- <summary>
- Gets or sets the language ID that is used to format the bibliographic sources in the document.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldCitation">
- <summary>
- Implements the CITATION field.
- </summary>
- <remarks>
- Inserts the contents of the <b>Source</b> element with a specified <b>Tag</b> element using a bibliographic style.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCitation.SourceTag">
- <summary>
- Gets or sets a value that mathes the <b>Tag</b> element's value of the source to insert.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCitation.FormatLanguageId">
- <summary>
- Gets or sets the language ID that is used in conjunction with the specified bibliographic style to format the citation
- in the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCitation.Prefix">
- <summary>
- Gets or sets a prefix that is prepended to the citation.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCitation.Suffix">
- <summary>
- Gets or sets a suffix that is appended to the citation.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCitation.SuppressAuthor">
- <summary>
- Gets or sets whether the author information is suppressed from the citation.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCitation.SuppressTitle">
- <summary>
- Gets or sets whether the title information is suppressed from the citation.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCitation.SuppressYear">
- <summary>
- Gets or sets whether the year information is suppressed from the citation.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCitation.PageNumber">
- <summary>
- Gets or sets a page number associated with the citation.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCitation.VolumeNumber">
- <summary>
- Gets or sets a volume number associated with the citation.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCitation.AnotherSourceTag">
- <summary>
- Gets or sets a value that mathes the <b>Tag</b> element's value of another source to be included in the citation.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldDde">
- <summary>
- Implements the DDE field.
- </summary>
- <remarks>
- For information copied from another application, this field links that information to its original source file using DDE.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDde.ProgId">
- <summary>
- Gets or sets the application type of the link information.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDde.SourceFullName">
- <summary>
- Gets or sets the name and location of the source file.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDde.SourceItem">
- <summary>
- Gets or sets the portion of the source file that's being linked.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDde.AutoUpdate">
- <summary>
- Gets or sets whether to update this field automatically.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDde.InsertAsBitmap">
- <summary>
- Gets or sets whether to insert the linked object as a bitmap.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDde.IsLinked">
- <summary>
- Gets or sets whether to reduce the file size by not storing graphics data with the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDde.InsertAsHtml">
- <summary>
- Gets or sets whether to insert the linked object as HTML format text.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDde.InsertAsPicture">
- <summary>
- Gets or sets whether to insert the linked object as a picture.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDde.InsertAsRtf">
- <summary>
- Gets or sets whether to insert the linked object in rich-text format (RTF).
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDde.InsertAsText">
- <summary>
- Gets or sets whether to insert the linked object in text-only format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDde.InsertAsUnicode">
- <summary>
- Gets or sets whether to insert the linked object as Unicode text.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldDdeAuto">
- <summary>
- Implements the DDEAUTO field.
- </summary>
- <remarks>
- For information copied from another application, this field links that information to its original source file using DDE
- and is updated automatically.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDdeAuto.ProgId">
- <summary>
- Gets or sets the application type of the link information.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDdeAuto.SourceFullName">
- <summary>
- Gets or sets the name and location of the source file.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDdeAuto.SourceItem">
- <summary>
- Gets or sets the portion of the source file that's being linked.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDdeAuto.InsertAsBitmap">
- <summary>
- Gets or sets whether to insert the linked object as a bitmap.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDdeAuto.IsLinked">
- <summary>
- Gets or sets whether to reduce the file size by not storing graphics data with the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDdeAuto.InsertAsHtml">
- <summary>
- Gets or sets whether to insert the linked object as HTML format text.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDdeAuto.InsertAsPicture">
- <summary>
- Gets or sets whether to insert the linked object as a picture.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDdeAuto.InsertAsRtf">
- <summary>
- Gets or sets whether to insert the linked object in rich-text format (RTF).
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDdeAuto.InsertAsText">
- <summary>
- Gets or sets whether to insert the linked object in text-only format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDdeAuto.InsertAsUnicode">
- <summary>
- Gets or sets whether to insert the linked object as Unicode text.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldFillIn">
- <summary>
- Implements the FILLIN field.
- </summary>
- <remarks>
- Prompts the user to enter text.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldFillIn.PromptText">
- <summary>
- Gets or sets the prompt text (the title of the prompt window).
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldFillIn.PromptOnceOnMailMerge">
- <summary>
- Gets or sets whether the user response should be recieved once per a mail merge operation.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldFillIn.DefaultResponse">
- <summary>
- Gets or sets default user response (initial value contained in the prompt window).
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldGlossary">
- <summary>
- Implements the GLOSSARY field.
- </summary>
- <remarks>
- Inserts a glossary entry.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldGlossary.EntryName">
- <summary>
- Gets or sets the name of the glossary entry to insert.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldImport">
- <summary>
- Implements the IMPORT field.
- </summary>
- <remarks>
- Retrieves the picture contained in the document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldImport.SourceFullName">
- <summary>
- Gets or sets the location of the picture.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldImport.GraphicFilter">
- <summary>
- Gets or sets the name of the filter for the format of the graphic that is to be inserted.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldImport.IsLinked">
- <summary>
- Gets or sets whether to reduce the file size by not storing graphics data with the document.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldInclude">
- <summary>
- Implements the INCLUDE field.
- </summary>
- <remarks>
- Inserts all or part of the text and graphics contained in another document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldInclude.SourceFullName">
- <summary>
- Gets or sets the location of the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldInclude.BookmarkName">
- <summary>
- Gets or sets the name of the bookmark in the document to include.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldInclude.LockFields">
- <summary>
- Gets or sets whether to prevent fields in the included document from being updated.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldInclude.TextConverter">
- <summary>
- Gets or sets the name of the text converter for the format of the included file.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldShape">
- <summary>
- Implements the SHAPE field.
- </summary>
- <remarks>
- Retrieves the specified text.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldShape.Text">
- <summary>
- Gets or sets the text to retrieve.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldDatabase">
- <summary>
- Implements the DATABASE field.
- </summary>
- <remarks>
- Inserts the results of a database query into a WordprocessingML table.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDatabase.FormatAttributes">
- <summary>
- Gets or sets which attributes of the format are to be applied to the table.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDatabase.Connection">
- <summary>
- Gets or sets a connection to the data.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDatabase.FileName">
- <summary>
- Gets or sets the complete path and file name of the database
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDatabase.FirstRecord">
- <summary>
- Gets or sets the integral record number of the first data record to insert.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDatabase.InsertHeadings">
- <summary>
- Gets or sets whether to insert the field names from the database as column headings in
- the resulting table.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDatabase.TableFormat">
- <summary>
- Gets or sets the format that is to be applied to the result of the database query.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDatabase.InsertOnceOnMailMerge">
- <summary>
- Gets or sets whether to insert data at the beginning of a merge.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDatabase.Query">
- <summary>
- Gets or sets a set of SQL instructions that query the database.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDatabase.LastRecord">
- <summary>
- Gets or sets the integral record number of the last data record to insert.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldSkipIf">
- <summary>
- Implements the SKIPIF field.
- </summary>
- <remarks>
- Compares the values designated by the expressions <see cref="P:Aspose.Words.Fields.FieldSkipIf.LeftExpression" /> and <see cref="P:Aspose.Words.Fields.FieldSkipIf.RightExpression" />
- in comparison using the operator designated by <see cref="P:Aspose.Words.Fields.FieldSkipIf.ComparisonOperator" />. If the comparison is true, SKIPIF
- cancels the current merge document, moves to the next data record in the data source, and starts a new merge document.
- If the comparison is false, the current merge document is continued.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSkipIf.LeftExpression">
- <summary>
- Gets or sets the left part of the comparison expression.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSkipIf.ComparisonOperator">
- <summary>
- Gets or sets the comparison operator.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSkipIf.RightExpression">
- <summary>
- Gets or sets the right part of the comparison expression.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.MergeFieldImageDimension">
- <summary>
- Represents an image dimension (i.e. the width or the height) used across a mail merge process.
- </summary>
- <remarks>
- To indicate that the image should be inserted with its original dimension during a mail merge,
- you should assign a negative value to the <see cref="P:Aspose.Words.Fields.MergeFieldImageDimension.Value" /> property.
- <seealso cref="T:Aspose.Words.Fields.MergeFieldImageDimensionUnit" /></remarks>
- </member>
- <member name="M:Aspose.Words.Fields.MergeFieldImageDimension.#ctor(System.Double)">
- <summary>
- Creates an image dimension instance with the given value in points.
- </summary>
- <remarks>
- You should use a negative value to indicate that the original value of the corresponding image dimension
- should be applied.
- </remarks>
- <param name="value">The value.</param>
- </member>
- <member name="M:Aspose.Words.Fields.MergeFieldImageDimension.#ctor(System.Double,Aspose.Words.Fields.MergeFieldImageDimensionUnit)">
- <summary>
- Creates an image dimension instance with the given value and the given unit.
- </summary>
- <remarks>
- You should use a negative value to indicate that the original value of the corresponding image dimension
- should be applied.
- </remarks>
- <param name="value">The value.</param>
- <param name="unit">The unit.</param>
- </member>
- <member name="M:Aspose.Words.Fields.MergeFieldImageDimension.#ctor">
- <summary>
- Ctor for internal using.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.MergeFieldImageDimension.Value">
- <summary>
- The value.
- </summary>
- <remarks>
- You should use a negative value to indicate that the original value of the corresponding image dimension
- should be applied.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.MergeFieldImageDimension.Unit">
- <summary>
- The unit.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.MergeFieldImageDimensionUnit">
- <summary>
- Specifies an unit of an image dimension (i.e. the width or the height) used across a mail merge process.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.MergeFieldImageDimensionUnit.Point">
- <summary>
- The point (i.e. 1/72 inch).
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.MergeFieldImageDimensionUnit.Percent">
- <summary>
- The percent of the original image dimension value.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldListNum">
- <summary>
- Implements the LISTNUM field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldListNum.ListName">
- <summary>
- Gets or sets the name of the abstract numbering definition used for the numbering.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldListNum.HasListName">
- <summary>
- Returns a value indicating whether the name of an abstract numbering definition
- is provided by the field's code.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldListNum.ListLevel">
- <summary>
- Gets or sets the level in the list, overriding the default behavior of the field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldListNum.StartingNumber">
- <summary>
- Gets or sets the starting value for this field.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldRevNum">
- <summary>
- Implements the REVNUM field.
- </summary>
- <remarks>
- Retrieves the document's revision number, as recorded in the <b>Revision</b> property of the
- built-in document properties.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldSection">
- <summary>
- Implements the SECTION field.
- </summary>
- <remarks>
- Retrieves the number of the current section.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldSectionPages">
- <summary>
- Implements the SECTIONPAGES field.
- </summary>
- <remarks>
- Retrieves the number of the current page within the current section.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldData">
- <summary>
- Implements the DATA field.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldEmbed">
- <summary>
- Implements the EMBED field.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldOcx">
- <summary>
- Implements the OCX field.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldAutoNum">
- <summary>
- Implements the AUTONUM field.
- </summary>
- <remarks>
- Inserts an automatic number.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAutoNum.SeparatorCharacter">
- <summary>
- Gets or sets the separator character to be used.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldAutoNumLgl">
- <summary>
- Implements the AUTONUMLGL field.
- </summary>
- <remarks>
- Inserts an automatic number in legal format.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAutoNumLgl.RemoveTrailingPeriod">
- <summary>
- Gets or sets whether to display the number without a trailing period.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAutoNumLgl.SeparatorCharacter">
- <summary>
- Gets or sets the separator character to be used.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldAutoNumOut">
- <summary>
- Implements the AUTONUMOUT field.
- </summary>
- <remarks>
- Inserts an automatic number in outline format.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldAddIn">
- <summary>
- Implements the ADDIN field.
- </summary>
- <remarks>
- Contains data created by an add-in.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldBarcode">
- <summary>
- Implements the BARCODE field.
- </summary>
- <remarks>
- Inserts a postal barcode in a machine-readable form of address used by the U.S. Postal Service.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldBarcode.PostalAddress">
- <summary>
- Gets or sets the postal address used for generating a barcode or the name of the bookmark that refers to it.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldBarcode.IsBookmark">
- <summary>
- Gets or sets whether <see cref="P:Aspose.Words.Fields.FieldBarcode.PostalAddress" /> is the name of a bookmark.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldBarcode.FacingIdentificationMark">
- <summary>
- Gets or sets the type of a Facing Identification Mark (FIM) to insert.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldBarcode.IsUSPostalAddress">
- <summary>
- Gets or sets whether <see cref="P:Aspose.Words.Fields.FieldBarcode.PostalAddress" /> is a U.S. postal address.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldBidiOutline">
- <summary>
- Implements the BIDIOUTLINE field.
- </summary>
- <remarks>
- This field is identical to the AUTONUMLGL field, except for the separator that delimits each level
- of the paragraph numbering.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldEQ">
- <summary>
- Implements the EQ field.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldFootnoteRef">
- <summary>
- Implements the FOOTNOTEREF field.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldInfo">
- <summary>
- Implements the INFO field.
- </summary>
- <remarks>
- Inserts information about a document property.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldInfo.InfoType">
- <summary>
- Gets or sets the type of the document property to insert.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldInfo.NewValue">
- <summary>
- Gets or sets an optional value that updates the property.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldUserAddress">
- <summary>
- Implements the USERADDRESS field.
- </summary>
- <remarks>
- Retrieves the current user's postal address.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldUserAddress.UserAddress">
- <summary>
- Gets or sets the current user's postal address.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldUserInitials">
- <summary>
- Implements the USERINITIALS field.
- </summary>
- <remarks>
- Retrieves the current user's initials.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldUserInitials.UserInitials">
- <summary>
- Gets or sets the current user's initials.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldUserName">
- <summary>
- Implements the USERNAME field.
- </summary>
- <remarks>
- Retrieves the current user's name.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldUserName.UserName">
- <summary>
- Gest or sets the current user's name.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.IFieldUserPromptRespondent">
- <summary>
- Represents the respondent to user prompts during field update.
- </summary>
- <remarks>
- The ASK and FILLIN fields are the examples of fields that prompt the user for some response. Implement this interface
- and assign it to the <see cref="P:Aspose.Words.Fields.FieldOptions.UserPromptRespondent" /> property to establish interaction between field update
- and the user.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.IFieldUserPromptRespondent.Respond(System.String,System.String)">
- <summary>
- When implemented, returns a response from the user on prompting.
- Your implementation should return <b>null</b> to indicate that the user has not responded to the prompt
- (i.e. the user has pressed the Cancel button in the prompt window).
- </summary>
- <param name="promptText">Prompt text (i.e. title of the prompt window).</param>
- <param name="defaultResponse">Default user response (i.e. initial value contained in the prompt window).</param>
- <returns>User response (i.e. confirmed value contained in the prompt window).</returns>
- </member>
- <member name="T:Aspose.Words.Fields.FieldIncludePicture">
- <summary>
- Implements the INCLUDEPICTURE field.
- </summary>
- <remarks>
- Retrieves a picture and displays it as the field result.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIncludePicture.SourceFullName">
- <summary>
- Gets or sets the location of the picture using an IRI.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIncludePicture.GraphicFilter">
- <summary>
- Gets or sets the name of the filter for the format of the graphic that is to be inserted.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIncludePicture.IsLinked">
- <summary>
- Gets or sets whether to reduce the file size by not storing graphics data with the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIncludePicture.ResizeHorizontally">
- <summary>
- Gets or sets whether to resize the picture horizontally from the source.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIncludePicture.ResizeVertically">
- <summary>
- Gets or sets whether to resize the picture vertically from the source.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldPage">
- <summary>
- Implements the PAGE field.
- </summary>
- <remarks>
- Retrieves the number of the current page.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldOptions">
- <summary>
- Represents options to control field handling in a document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.FieldUpdateCultureSource">
- <summary>
- Specifies what culture to use to format the field result.
- </summary>
- <remarks>
- <para>By default, the culture of the current thread is used.</para>
- <para>The setting affects only date/time fields with \\@ format switch.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.FieldUpdateCultureProvider">
- <summary>
- Gets or sets a provider that returns a culture object specific for each particular field.
- </summary>
- <remarks>
- <para>The provider is requested when the value of <see cref="P:Aspose.Words.Fields.FieldOptions.FieldUpdateCultureSource" /> is <b>FieldUpdateCultureSource.FieldCode</b>.</para>
- <para>If the provider is present, then the culture object it returns is used for the field update. Otherwise, a system culture is used.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.IsBidiTextSupportedOnUpdate">
- <summary>
- Gets or sets the value indicating whether bidirectional text is fully supported during field update or not.
- </summary>
- <remarks>
- <para>When this property is set to <b>true</b>, additional steps are performed to produce Right-To-Left language
- (i.e. Arabic or Hebrew) compatible field result during its update.</para>
- <para>When this property is set to <b>false</b> and Right-To-Left language is used, correctness of field result
- after its update is not guaranteed.</para>
- <para>The default value is <b>false</b>.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.UserPromptRespondent">
- <summary>
- Gets or sets the respondent to user prompts during field update.
- </summary>
- <remarks>
- <para>If the value of this property is set to <b>null</b>, the fields that require user response on prompting
- (such as ASK or FILLIN) are not updated.</para>
- <para>The default value is <b>null</b>.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.DefaultDocumentAuthor">
- <summary>
- Gets or sets default document author's name. If author's name is already specified in built-in document properties,
- this option is not considered.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.CustomTocStyleSeparator">
- <summary>
- Gets or sets custom style separator for the \t switch in TOC field.
- </summary>
- <remarks>
- By default, custom styles defined by the \t switch in the TOC field are separated by a delimiter taken from the current culture.
- This property overrides that behaviour by specifying a user defined delimiter.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.LegacyNumberFormat">
- <summary>
- Gets or sets the value indicating whether legacy (early than AW 13.10) number format for fields is enabled or not.
- </summary>
- <remarks>
- <para>When this property is set to <b>true</b>, template symbol "#" worked as in .net:
- Replaces the pound sign with the corresponding digit if one is present; otherwise, no symbols appears in the result string.</para>
- <para>When this property is set to <b>false</b>, template symbol "#" works as MS Word:
- This format item specifies the requisite numeric places to display in the result.
- If the result does not include a digit in that place, MS Word displays a space. For example, { = 9 + 6 \# $### } displays $ 15.</para>
- <para>The default value is <b>false</b>.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.UseInvariantCultureNumberFormat">
- <summary>
- Gets or sets the value indicating that number format is parsed using invariant culture or not
- </summary>
- <para>
- When this property is set to <b>true</b>, number format is taken from an invariant culture.
- </para>
- <para>
- When this property is set to <b>false</b>, number format is taken from the current thread's culture.
- </para>
- <para>The default value is <b>false</b>.</para>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.BarcodeGenerator">
- <summary>
- Gets or set custom barcode generator.
- </summary>
- <remarks>
- Custom barcode generator should implement public interface <see cref="T:Aspose.Words.Fields.IBarcodeGenerator" />.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.PreProcessCulture">
- <summary>
- Gets or sets the culture to preprocess field values.
- </summary>
- <remarks>
- <p>Currently this property only affects value of the DOCPROPERTY field.</p>
- <p>The default value is <b>null</b>. When this property is set to <b>null</b>, the DOCPROPERTY field's value is preprocessed
- with the culture controlled by the <see cref="P:Aspose.Words.Fields.FieldOptions.FieldUpdateCultureSource" /> property.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.CurrentUser">
- <summary>
- Gets or sets the current user information.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.ToaCategories">
- <summary>
- Gets or sets the table of authorities categories.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.FieldIndexFormat">
- <summary>
- Gets or sets a <see cref="P:Aspose.Words.Fields.FieldOptions.FieldIndexFormat" /> that represents
- the formatting for the <see cref="T:Aspose.Words.Fields.FieldIndex" /> fields in the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.FileName">
- <summary>
- Gets or sets the file name of the document.
- </summary>
- <remarks>
- <p>This property is used by the FILENAME field with higher priority than the <see cref="P:Aspose.Words.Document.OriginalFileName" /> property.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.ResultFormatter">
- <summary>
- Allows to control how the field result is formatted.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldOptions.BuiltInTemplatesPaths">
- <summary>
- Gets or sets paths of MS Word built-in templates.
- </summary>
- <remarks>
- <p>This property is used by the AUTOTEXT and GLOSSARY fields, if referenced auto text entry is not found in the <see cref="P:Aspose.Words.Document.AttachedTemplate" /> template.</p>
- <p>By defalut MS Word stores built-in templates in c:\Users\<username>\AppData\Roaming\Microsoft\Document Building Blocks\1033\16\Built-In Building Blocks.dotx and
- C:\Users\<username>\AppData\Roaming\Microsoft\Templates\Normal.dotm files.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldCreateDate">
- <summary>
- Implements the CREATEDATE field.
- </summary>
- <remarks>
- Retrieves the date and time at which the document was created. By default, the Gregorian calendar is used.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCreateDate.UseLunarCalendar">
- <summary>
- Gets or sets whether to use the Hijri Lunar or Hebrew Lunar calendar.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCreateDate.UseSakaEraCalendar">
- <summary>
- Gets or sets whether to use the Saka Era calendar.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCreateDate.UseUmAlQuraCalendar">
- <summary>
- Gets or sets whether to use the Um-al-Qura calendar.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldEditTime">
- <summary>
- Implements the EDITTIME field.
- </summary>
- <remarks>
- Retrieves the total editing time, in minutes, since the document was created.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldPrintDate">
- <summary>
- Implements the PRINTDATE field.
- </summary>
- <remarks>
- Retrieves the date and time on which the document was last printed. By default, the Gregorian calendar is used.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldPrintDate.UseLunarCalendar">
- <summary>
- Gets or sets whether to use the Hijri Lunar or Hebrew Lunar calendar.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldPrintDate.UseSakaEraCalendar">
- <summary>
- Gets or sets whether to use the Saka Era calendar.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldPrintDate.UseUmAlQuraCalendar">
- <summary>
- Gets or sets whether to use the Um-al-Qura calendar.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldSaveDate">
- <summary>
- Implements the SAVEDATE field.
- </summary>
- <remarks>
- Retrieves the date and time on which the document was last saved. By default, the Gregorian calendar is used.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSaveDate.UseLunarCalendar">
- <summary>
- Gets or sets whether to use the Hijri Lunar or Hebrew Lunar calendar.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSaveDate.UseSakaEraCalendar">
- <summary>
- Gets or sets whether to use the Saka Era calendar.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSaveDate.UseUmAlQuraCalendar">
- <summary>
- Gets or sets whether to use the Um-al-Qura calendar.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldGoToButton">
- <summary>
- Implements the GOTOBUTTON field.
- </summary>
- <remarks>
- Inserts a jump command, such that when it is activated, the insertion point of the document is
- moved to the specified location.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldGoToButton.Location">
- <summary>
- Gets or sets the name of a bookmark, a page number, or some other item to jump to.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldGoToButton.DisplayText">
- <summary>
- Gets or sets the text of the "button" that appears in the document, such that it can be selected to activate the jump.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldAuthor">
- <summary>
- Implements the AUTHOR field.
- </summary>
- <remarks>
- Retrieves, and optionally sets, the document author's name, as recorded in the <b>Author</b> property of the
- built-in document properties.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAuthor.AuthorName">
- <summary>
- Gets or sets the document author's name.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldComments">
- <summary>
- Implements the COMMENTS field.
- </summary>
- <remarks>
- Retrieves, and optionally sets, the comments relating to the current document, as recorded in the <b>Comments</b> property
- of the built-in document properties.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldComments.Text">
- <summary>
- Gets or sets the text of the comments.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldFileName">
- <summary>
- Implements the FILENAME field.
- </summary>
- <remarks>
- <p>Retrieves the name of the current document from its storage location.</p>
- <p>In the current implementation, uses the <see cref="P:Aspose.Words.Document.OriginalFileName" /> property to retrieve
- the file name. If the document was loaded from a stream or created blank, uses the name of the file that is being saved to (if known).</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldFileName.IncludeFullPath">
- <summary>
- Gets or sets whether to include the full file path name.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldFileSize">
- <summary>
- Implements the FILESIZE field.
- </summary>
- <remarks>
- <p>Retrieves the size of the current document's file or 0 if the size cannot be determined.</p>
- <p>In the current implementation, uses the <see cref="P:Aspose.Words.Document.OriginalFileName" /> property to retrieve
- the file name used to determine the file size.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldFileSize.IsInKilobytes">
- <summary>
- Gets or sets whether to display the file size in kilobytes.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldFileSize.IsInMegabytes">
- <summary>
- Gets or sets whether to display the file size in megabytes.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldKeywords">
- <summary>
- Implements the KEYWORDS field.
- </summary>
- <remarks>
- Retrieves, and optionally sets, the document's keywords, as recorded in the <b>Keywords</b> property of the
- built-in document properties.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldKeywords.Text">
- <summary>
- Gets or sets the text of the keywords.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldLastSavedBy">
- <summary>
- Implements the LASTSAVEDBY field.
- </summary>
- <remarks>
- Retrieves the name of the user who last modified and saved the current document, as recorded in the <b>LastModifiedBy</b>
- property of the built-in document properties.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldNumChars">
- <summary>
- Implements the NUMCHARS field.
- </summary>
- <remarks>
- Retrieves the number of characters in the current document, as recorded in the <b>Characters</b> property of the
- built-in document properties.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldNumPages">
- <summary>
- Implements the NUMPAGES field.
- </summary>
- <remarks>
- Retrieves the number of pages in the current document, as recorded in the <b>Pages</b> property of the
- built-in document properties.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldNumWords">
- <summary>
- Implements the NUMWORDS field.
- </summary>
- <remarks>
- Retrieves the number of words in the current document, as recorded in the <b>Words</b> property of the
- built-in document properties.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldSubject">
- <summary>
- Implements the SUBJECT field.
- </summary>
- <remarks>
- Retrieves, and optionally sets, the document's subject, as recorded in the <b>Subject</b> property of the
- built-in document properties.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSubject.Text">
- <summary>
- Gets or sets the text of the subject.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldTemplate">
- <summary>
- Implements the TEMPLATE field.
- </summary>
- <remarks>
- Retrieves the file name of the template used by the current document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldTemplate.IncludeFullPath">
- <summary>
- Gets or sets whether to include the full file path name.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldTitle">
- <summary>
- Implements the TITLE field.
- </summary>
- <remarks>
- Retrieves, and optionally sets, the document's title, as recorded in the <b>Title</b> property of the
- built-in document properties.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldTitle.Text">
- <summary>
- Gets or sets the text of the title.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldFormula">
- <summary>
- Implements the = (formula) field.
- </summary>
- <remarks>
- Calcualtes the result of an expression.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldSymbol">
- <summary>
- Implements a SYMBOL field.
- </summary>
- <remarks>
- Retrieves the character whose code point value is specified in decimal or hexadecimal.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSymbol.CharacterCode">
- <summary>
- Gets or sets the character's code point value in decimal or hexadecimal.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSymbol.FontName">
- <summary>
- Gets or sets the name of the font of the character retrieved by the field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSymbol.FontSize">
- <summary>
- Gets or sets the size in points of the font of the character retrieved by the field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSymbol.IsAnsi">
- <summary>
- Gets or sets whether the character code is interpreted as the value of an ANSI character.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSymbol.IsUnicode">
- <summary>
- Gets or sets whether the character code is interpreted as the value of a Unicode character.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSymbol.IsShiftJis">
- <summary>
- Gets or sets whether the character code is interpreted as the value of a SHIFT-JIS character.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSymbol.DontAffectsLineSpacing">
- <summary>
- Gets or sets whether the character retrieved by the field affects the line spacing of the paragraph.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldQuote">
- <summary>
- Implements the QUOTE field.
- </summary>
- <remarks>
- Retrieves the specified text.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldQuote.Text">
- <summary>
- Gets or sets the text to retrieve.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldSet">
- <summary>
- Implements the SET field.
- </summary>
- <remarks>
- Assigns new text to a bookmark.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSet.BookmarkName">
- <summary>
- Gets or sets the name of the bookmark.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSet.BookmarkText">
- <summary>
- Gets or sets the new text of the bookmark.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldAddressBlock">
- <summary>
- Implements the ADDRESSBLOCK field.
- </summary>
- <remarks>
- Represents an address block. An <i>address block</i> is a block of text specifying information
- appropriate for a postal mailing address, in the order required by the destination country.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.FieldAddressBlock.GetFieldNames">
- <summary>
- Returns a collection of mail merge field names used by the field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAddressBlock.FormatAddressOnCountryOrRegion">
- <summary>
- Gets or sets whether to format the address according to the country/region of the recipient
- as defined by POST*CODE (Universal Postal Union 2006).
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAddressBlock.IncludeCountryOrRegionName">
- <summary>
- Gets or sets whether to include the name of the country/region.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAddressBlock.ExcludedCountryOrRegionName">
- <summary>
- Gets or sets the excluded country/region name.
- </summary>
- <dev>TODO DV May be more than one.</dev>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAddressBlock.NameAndAddressFormat">
- <summary>
- Gets or sets the name and address format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldAddressBlock.LanguageId">
- <summary>
- Gets or sets the language ID used to format the address.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldCompare">
- <summary>
- Implements the COMPARE field.
- </summary>
- <remarks>
- Compares the values designated by the expressions <see cref="P:Aspose.Words.Fields.FieldCompare.LeftExpression" /> and <see cref="P:Aspose.Words.Fields.FieldCompare.RightExpression" />
- in comparison using the operator designated by <see cref="P:Aspose.Words.Fields.FieldCompare.ComparisonOperator" />.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCompare.LeftExpression">
- <summary>
- Gets or sets the left part of the comparison expression.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCompare.ComparisonOperator">
- <summary>
- Gets or sets the comparison operator.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldCompare.RightExpression">
- <summary>
- Gets or sets the right part of the comparison expression.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldDate">
- <summary>
- Implements the DATE field.
- </summary>
- <remarks>
- Inserts the current date and time. By default, the Gregorian calendar is used.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDate.UseLunarCalendar">
- <summary>
- Gets or sets whether to use the Hijri Lunar or Hebrew Lunar calendar.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDate.UseLastFormat">
- <summary>
- Gets or sets whether to use a format last used by the hosting application when inserting a new DATE field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDate.UseSakaEraCalendar">
- <summary>
- Gets or sets whether to use the Saka Era calendar.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDate.UseUmAlQuraCalendar">
- <summary>
- Gets or sets whether to use the Um-al-Qura calendar.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldDocProperty">
- <summary>
- Implements the DOCPROPERTY field.
- </summary>
- <remarks>
- Retrieves the indicated document information.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldDocVariable">
- <summary>
- Implements DOCVARIABLE field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldDocVariable.VariableName">
- <summary>
- Gets or sets the name of the document variable to retrieve.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldGreetingLine">
- <summary>
- Implements the GREETINGLINE field.
- </summary>
- <remarks>
- Inserts a mail merge greeting line.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.FieldGreetingLine.GetFieldNames">
- <summary>
- Returns a collection of mail merge field names used by the field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldGreetingLine.AlternateText">
- <summary>
- Gets or sets the text to include in the field if the name is blank.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldGreetingLine.NameFormat">
- <summary>
- Gets or sets the format of the name included in the field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldGreetingLine.LanguageId">
- <summary>
- Gets or sets the language id used to format the name.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldHyperlink">
- <summary>
- Implements the HYPERLINK field
- </summary>
- <remarks>
- When selected, causes control to jump to the location such as a bookmark or a URL.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldHyperlink.Target">
- <summary>
- Gets or sets the target to which the link should be redirected.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldHyperlink.Address">
- <summary>
- Gets or sets a location where this hyperlink jumps.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldHyperlink.SubAddress">
- <summary>
- Gets or sets a location in the file, such as a bookmark, where this hyperlink jumps.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldHyperlink.IsImageMap">
- <summary>
- Gets or sets whether to append coordinates to the hyperlink for a server-side image map.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldHyperlink.OpenInNewWindow">
- <summary>
- Gets or sets whether to open the destination site in a new web browser window.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldHyperlink.ScreenTip">
- <summary>
- Gets or sets the ScreenTip text for the hyperlink.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldIf">
- <summary>
- Implements the IF field.
- </summary>
- <remarks>
- <p>Compares the values designated by the expressions <see cref="P:Aspose.Words.Fields.FieldIf.LeftExpression" /> and <see cref="P:Aspose.Words.Fields.FieldIf.RightExpression" />
- in comparison using the operator designated by <see cref="P:Aspose.Words.Fields.FieldIf.ComparisonOperator" />.</p>
- <p>A field in the following format will be used as a mail merge source: { IF 0 = 0 "{PatientsNameFML}" "" \* MERGEFORMAT }</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.FieldIf.EvaluateCondition">
- <summary>
- Evaluates the condition.
- </summary>
- <returns>
- A <see cref="T:Aspose.Words.Fields.FieldIfComparisonResult" /> value that represents the result of the condition evaluation.
- </returns>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIf.LeftExpression">
- <summary>
- Gets or sets the left part of the comparison expression.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIf.ComparisonOperator">
- <summary>
- Gets or sets the comparison operator.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIf.RightExpression">
- <summary>
- Gets or sets the right part of the comparison expression.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIf.TrueText">
- <summary>
- Gets or sets the text displayed if the comparison expression is true.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIf.FalseText">
- <summary>
- Gets or sets the text displayed if the comparison expression is false.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldIncludeText">
- <summary>
- Implements the INCLUDETEXT field.
- </summary>
- <remarks>
- Inserts all or part of the text and graphics contained in another document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIncludeText.SourceFullName">
- <summary>
- Gets or sets the location of the document using an IRI.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIncludeText.BookmarkName">
- <summary>
- Gets or sets the name of the bookmark in the document to include.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIncludeText.LockFields">
- <summary>
- Gets or sets whether to prevent fields in the included document from being updated.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIncludeText.TextConverter">
- <summary>
- Gets or sets the name of the text converter for the format of the included file.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIncludeText.NamespaceMappings">
- <summary>
- Gets or sets the namespace mappings for XPath queries.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIncludeText.XslTransformation">
- <summary>
- Gets or sets the location of XSL Transformation to format XML data.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIncludeText.XPath">
- <summary>
- Gets or sets XPath for the desired portion of the XML file.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIncludeText.Encoding">
- <summary>
- Gets or sets the encoding applied to the data within the referenced file.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldIncludeText.MimeType">
- <summary>
- Gets or sets the MIME type of the referenced file.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldLink">
- <summary>
- Implements the LINK field.
- </summary>
- <remarks>
- For information copied from another application, this field links that information to its original
- source file.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldLink.ProgId">
- <summary>
- Gets or sets the application type of the link information.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldLink.SourceFullName">
- <summary>
- Gets or sets the name and location of the source file.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldLink.SourceItem">
- <summary>
- Gets or sets the portion of the source file that's being linked.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldLink.AutoUpdate">
- <summary>
- Gets or sets whether to update this field automatically.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldLink.InsertAsBitmap">
- <summary>
- Gets or sets whether to insert the linked object as a bitmap.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldLink.IsLinked">
- <summary>
- Gets or sets whether to reduce the file size by not storing graphics data with the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldLink.FormatUpdateType">
- <summary>
- Gets or sets a way the linked object updates its formatting.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldLink.InsertAsHtml">
- <summary>
- Gets or sets whether to insert the linked object as HTML format text.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldLink.InsertAsPicture">
- <summary>
- Gets or sets whether to insert the linked object as a picture.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldLink.InsertAsRtf">
- <summary>
- Gets or sets whether to insert the linked object in rich-text format (RTF).
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldLink.InsertAsText">
- <summary>
- Gets or sets whether to insert the linked object in text-only format.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldLink.InsertAsUnicode">
- <summary>
- Gets or sets whether to insert the linked object as Unicode text.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldMacroButton">
- <summary>
- Implements the MACROBUTTON field.
- </summary>
- <remarks>
- <p>Allows a macro or command to be run.</p>
- <p>In Aspose.Words this field can also act as a merge field.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMacroButton.MacroName">
- <summary>
- Gets or sets the name of the macro or command to run.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMacroButton.DisplayText">
- <summary>
- Gets or sets the text to appear as the "button" that is selected to run the macro or command.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldMergeField">
- <summary>
- Implements the MERGEFIELD field.
- </summary>
- <remarks>
- Retrieves the name of a data field within the merge characters in a mail merge main document.
- When the main document is merged with the selected data source, information from the specified
- data field is inserted in place of the merge field.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeField.Type">
- <summary>
- Gets the Microsoft Word field type.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeField.FieldNameNoPrefix">
- <summary>
- Returns just the name of the data field. Any prefix is stripped to the prefix property.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeField.FieldName">
- <summary>
- Gets or sets the name of a data field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeField.TextBefore">
- <summary>
- Gets or sets the text to be inserted before the field if the field is not blank.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeField.TextAfter">
- <summary>
- Gets or sets the text to be inserted after the field if the field is not blank.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeField.IsMapped">
- <summary>
- Gets or sets whether this field is a mapped field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldMergeField.IsVerticalFormatting">
- <summary>
- Gets or sets whether to enable character conversion for vertical formatting.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldMergeRec">
- <summary>
- Implements the MERGEREC field.
- </summary>
- <remarks>
- At the moment the MERGEREC and MERGESEQ fields implement the same functionality because we don't know for sure
- how to skip records in Aspose.Words mail merge.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldMergeSeq">
- <summary>
- Implements the MERGESEQ field.
- </summary>
- <remarks>
- At the moment the MERGEREC and MERGESEQ fields implement the same functionality because we don't know for sure
- how to skip records in Aspose.Words mail merge.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldNext">
- <summary>
- Implements the NEXT field.
- </summary>
- <remarks>
- Merges the next data record into the current resulting merged document, rather than starting a
- new merged document.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldNextIf">
- <summary>
- Implements the NEXTIF field.
- </summary>
- <remarks>
- Compares the values designated by the expressions <see cref="P:Aspose.Words.Fields.FieldNextIf.LeftExpression" /> and <see cref="P:Aspose.Words.Fields.FieldNextIf.RightExpression" />
- in comparison using the operator designated by <see cref="P:Aspose.Words.Fields.FieldNextIf.ComparisonOperator" />. If the comparison is true,
- the next data record is merged into the current merge document. (Merge fields that follow the NEXTIF in the main
- document are replaced by values from the next data record rather than the current data record.)
- If the comparison is false, the next data record is merged into a new merge document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldNextIf.LeftExpression">
- <summary>
- Gets or sets the left part of the comparison expression.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldNextIf.ComparisonOperator">
- <summary>
- Gets or sets the comparison operator.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldNextIf.RightExpression">
- <summary>
- Gets or sets the right part of the comparison expression.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldNoteRef">
- <summary>
- Implements the NOTEREF field.
- </summary>
- <remarks>
- Inserts the mark of the footnote or endnote that is marked by the specified bookmark.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldNoteRef.BookmarkName">
- <summary>
- Gets or sets the name of the bookmark.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldNoteRef.InsertReferenceMark">
- <summary>
- Inserts the reference mark with the same character formatting as the Footnote Reference
- or Endnote Reference style.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldNoteRef.InsertHyperlink">
- <summary>
- Gets or sets whether to insert a hyperlink to the bookmarked paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldNoteRef.InsertRelativePosition">
- <summary>
- Gets or sets whether to insert a relative position of the bookmarked paragraph.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldPageRef">
- <summary>
- Implements the PAGEREF field.
- </summary>
- <remarks>
- Inserts the number of the page containing the specified bookmark for a cross-reference.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldPageRef.BookmarkName">
- <summary>
- Gets or sets the name of the bookmark.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldPageRef.InsertHyperlink">
- <summary>
- Gets or sets whether to insert a hyperlink to the bookmarked paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldPageRef.InsertRelativePosition">
- <summary>
- Gets or sets whether to insert a relative position of the bookmarked paragraph.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldRef">
- <summary>
- Implements the REF field.
- </summary>
- <remarks>
- Inserts the text or graphics represented by the specified bookmark.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldRef.BookmarkName">
- <summary>
- Gets or sets the referenced bookmark's name.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldRef.NumberSeparator">
- <summary>
- Gets or sets the character sequence that is used to separate sequence numbers and page numbers.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldRef.IncludeNoteOrComment">
- <summary>
- Gets or sets whether to increment footnote, endnote, and annotation numbers that are
- marked by the bookmark, and insert the corresponding footnote, endnote, and comment text.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldRef.InsertHyperlink">
- <summary>
- Gets or sets whether to create a hyperlink to the bookmarked paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldRef.InsertParagraphNumber">
- <summary>
- Gets or sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldRef.InsertRelativePosition">
- <summary>
- Gets or sets whether to insert the relative position of the referenced paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldRef.InsertParagraphNumberInRelativeContext">
- <summary>
- Gets or sets whether to insert the paragraph number of the referenced paragraph in relative context.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldRef.SuppressNonDelimiters">
- <summary>
- Gets or sets whether to suppress non-delimiter characters.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldRef.InsertParagraphNumberInFullContext">
- <summary>
- Gets or sets whether to insert the paragraph number of the referenced paragraph in full context.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldSeq">
- <summary>
- Implements the SEQ field.
- </summary>
- <remarks>
- Sequentially numbers chapters, tables, figures, and other user-defined lists of items in a document.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSeq.SequenceIdentifier">
- <summary>
- Gets or sets the name assigned to the series of items that are to be numbered.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSeq.BookmarkName">
- <summary>
- Gets or sets a bookmark name that refers to an item elsewhere in the document rather than in the current location.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSeq.InsertNextNumber">
- <summary>
- Gets or sets whether to insert the next sequence number for the specified item.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSeq.ResetNumber">
- <summary>
- Gets or sets an integer number to reset the sequence number to. Returns -1 if the number is absent.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSeq.ResetHeadingLevel">
- <summary>
- Gets or sets an integer number representing a heading level to reset the sequence number to.
- Returns -1 if the number is absent.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldStyleRef">
- <summary>
- Implements the STYLEREF field.
- </summary>
- <remarks>
- The STYLEREF is used to reference a fragment of text within the document that is formatted with
- the specified style.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldStyleRef.StyleName">
- <summary>
- Gets or sets the name of the style by which the text to search for is formatted.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldStyleRef.SearchFromBottom">
- <summary>
- Gets or sets whether to search from the bottom of the current page, rather from the top.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldStyleRef.InsertParagraphNumber">
- <summary>
- Gets or sets whether to insert the paragraph number of the referenced paragraph exactly as it appears in the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldStyleRef.InsertRelativePosition">
- <summary>
- Gets or sets whether to insert the relative position of the referenced paragraph.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldStyleRef.InsertParagraphNumberInRelativeContext">
- <summary>
- Gets or sets whether to insert the paragraph number of the referenced paragraph in relative context.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldStyleRef.SuppressNonDelimiters">
- <summary>
- Gets or sets whether to suppress non-delimiter characters.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldStyleRef.InsertParagraphNumberInFullContext">
- <summary>
- Gets or sets whether to insert the paragraph number of the referenced paragraph in full context.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldTC">
- <summary>
- Implements the TC field.
- </summary>
- <remarks>
- Defines the text and page number for a table of contents (including a table of figures) entry, which
- is used by a TOC field.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldTC.Text">
- <summary>
- Gets or sets the text of the entry.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldTC.TypeIdentifier">
- <summary>
- Gets or sets a type identifier for this field (which is typically a letter).
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldTC.EntryLevel">
- <summary>
- Gets or sets the level of the entry.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldTC.OmitPageNumber">
- <summary>
- Gets or sets whether page number in TOC should be omitted for this field.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldTime">
- <summary>
- Implements the TIME field.
- </summary>
- <remarks>
- Inserts the current date and time.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldToc">
- <summary>
- Implements the TOC field.
- </summary>
- <remarks>
- Builds a table of contents (which can also be a table of figures) using the entries specified by TC fields,
- their heading levels, and specified styles, and inserts that table at this place in the document.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.FieldToc.UpdatePageNumbers">
- <summary>
- Updates the page numbers for items in this table of contents.
- </summary>
- <returns>
- True if the operation is successful. If any of the related TOC bookmarks was removed, false will be returned.
- </returns>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.BookmarkName">
- <summary>
- Gets or sets the name of the bookmark that marks the portion of the document used to build the table.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.TableOfFiguresLabel">
- <summary>
- Gets or sets the name of the sequence identifier used when building a table of figures.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.CaptionlessTableOfFiguresLabel">
- <summary>
- Gets or sets the name of the sequence identifier used when building a table of figures that does not include caption's
- label and number.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.SequenceSeparator">
- <summary>
- Gets or sets the character sequence that is used to separate sequence numbers and page numbers.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.EntryIdentifier">
- <summary>
- Gets or sets a string that should match type identifiers of TC fields being included.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.InsertHyperlinks">
- <summary>
- Gets or sets whether to make the table of contents entries hyperlinks.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.EntryLevelRange">
- <summary>
- Gets or sets a range of levels of the table of contents entries to be included.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.PageNumberOmittingLevelRange">
- <summary>
- Gets or sets a range of levels of the table of contents entries from which to omits page numbers.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.HeadingLevelRange">
- <summary>
- Gets or sets a range of heading levels to include.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.EntrySeparator">
- <summary>
- Gets or sets a sequence of characters that separate an entry and its page number.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.PrefixedSequenceIdentifier">
- <summary>
- Gets or sets the identifier of a sequence for which a prefix should be added to the entry's page number.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.CustomStyles">
- <summary>
- Gets or sets a list of styles other than the built-in heading styles to include in the table of contents.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.UseParagraphOutlineLevel">
- <summary>
- Gets or sets whether to use the applied paragraph outline level.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.PreserveTabs">
- <summary>
- Gets or sets whether to preserve tab entries within table entries.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.PreserveLineBreaks">
- <summary>
- Gets or sets whether to preserve newline characters within table entries.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldToc.HideInWebLayout">
- <summary>
- Gets or sets whether to hide tab leader and page numbers in Web layout view.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldXE">
- <summary>
- Implements the XE field.
- </summary>
- <remarks>
- Defines the text and page number for an index entry, which is used by an INDEX field.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FieldXE.Text">
- <summary>
- Gets or sets the text of the entry.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldXE.IsBold">
- <summary>
- Gets or sets whether to apply bold formatting to the entry's page number.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldXE.EntryType">
- <summary>
- Gets or sets an index entry type.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldXE.IsItalic">
- <summary>
- Gets or sets whether to apply italic formatting to the entry's page number.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldXE.PageRangeBookmarkName">
- <summary>
- Gets or sets the name of the bookmark that marks a range of pages that is inserted as the entry's page number.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldXE.HasPageRangeBookmarkName">
- <summary>
- Gets a value indicating whether a page range bookmark name is provided through the field's code.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldXE.PageNumberReplacement">
- <summary>
- Gets or sets text used in place of a page number.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldXE.Yomi">
- <summary>
- Gets or sets the yomi (first phonetic character for sorting indexes) for the index entry
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldUpdateCultureSource">
- <summary>
- Indicates what culture to use during field update.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldUpdateCultureSource.CurrentThread">
- <summary>
- The culture of the current execution thread is used to update fields.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldUpdateCultureSource.FieldCode">
- <summary>
- The culture specified in the field formatting properties via language setting is used.
- </summary>
- <remarks>
- To be exact, Aspose.Words mimics MS Word by using the language set for the first character of the field code.
- </remarks>
- <seealso cref="P:Aspose.Words.Fields.Field.LocaleId" />
- </member>
- <member name="T:Aspose.Words.Fields.GeneralFormat">
- <summary>
- Specifies a general format that is applied to a numeric, text, or any field result.
- A field may have a combination of general formats.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.None">
- <summary>
- Used to specify a missing general format.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Aiueo">
- <summary>
- Numeric formatting. Formats a numeric result using hiragana characters in the traditional a-i-u-e-o order.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.UppercaseAlphabetic">
- <summary>
- Numeric formatting. Formats a numeric result as one or more occurrences of an uppercase alphabetic Latin character.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.LowercaseAlphabetic">
- <summary>
- Numeric formatting. Formats a numeric result as one or more occurrences of an lowercase alphabetic Latin character.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Arabic">
- <summary>
- Numeric formatting. Formats a numeric result using Arabic cardinal numerals.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.ArabicAbjad">
- <summary>
- Numeric formatting. Formats a numeric result using ascending Abjad numerals.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.ArabicAlpha">
- <summary>
- Numeric formatting. Formats a numeric result using characters in the Arabic alphabet.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.ArabicDash">
- <summary>
- Numeric formatting. Formats a numeric result using Arabic cardinal numerals, with a prefix of "- " and a suffix of " -".
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.BahtText">
- <summary>
- Numeric formatting. Formats a numeric result in the Thai counting system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.CardText">
- <summary>
- Numeric formatting. Cardinal text (One, Two, Three, ...).
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.ChineseNum1">
- <summary>
- Numeric formatting. Formats a numeric result using ascending numbers from the appropriate counting system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.ChineseNum2">
- <summary>
- Numeric formatting. Formats a numeric result using sequential numbers from the appropriate legal format.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.ChineseNum3">
- <summary>
- Numeric formatting. Formats a numeric result using sequential numbers from the appropriate counting thousand system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Chosung">
- <summary>
- Numeric formatting. Formats a numeric result using sequential numbers from the Korean Chosung format.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.CircleNum">
- <summary>
- Numeric formatting. Formats a numeric result using decimal numbering enclosed in a circle, using the
- enclosed alphanumeric glyph character for numbers in the range 1–20.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.DBChar">
- <summary>
- Numeric formatting. Formats a numeric result using double-byte Arabic numbering.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.DBNum1">
- <summary>
- Numeric formatting. Formats a numeric result using sequential digital ideographs, using the appropriate character.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.DBNum2">
- <summary>
- Numeric formatting. Formats a numeric result using sequential numbers from the appropriate counting system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.DBNum3">
- <summary>
- Numeric formatting. Formats a numeric result using sequential numbers from the appropriate legal counting system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.DBNum4">
- <summary>
- Numeric formatting. Formats a numeric result using sequential numbers from the appropriate digital counting system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.DollarText">
- <summary>
- Numeric formatting. Dollar text (One, Two, Three, ... + AND 55/100).
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Ganada">
- <summary>
- Numeric formatting. Formats a numeric result using sequential numbers from the Korean Ganada format.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.GB1">
- <summary>
- Numeric formatting. Formats a numeric result using decimal numbering followed by a period, using
- the enclosed alphanumeric glyph character.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.GB2">
- <summary>
- Numeric formatting. Formats a numeric result using decimal numbering enclosed in parenthesis,
- using the enclosed alphanumeric glyph character.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.GB3">
- <summary>
- Numeric formatting. Formats a numeric result using decimal numbering enclosed in a circle, using the
- enclosed alphanumeric glyph character.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.GB4">
- <summary>
- Numeric formatting. Formats a numeric result using decimal numbering enclosed in a circle, using the
- enclosed alphanumeric glyph character.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Hebrew1">
- <summary>
- Numeric formatting. Formats a numeric result using Hebrew numerals.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Hebrew2">
- <summary>
- Numeric formatting. Formats a numeric result using the Hebrew alphabet.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Hex">
- <summary>
- Numeric formatting. Formats the numeric result using uppercase hexadecimal digits.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.HindiArabic">
- <summary>
- Numeric formatting. Formats a numeric result using Hindi numbers.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.HindiCardText">
- <summary>
- Numeric formatting. Formats a numeric result using sequential numbers from the Hindi counting system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.HindiLetter1">
- <summary>
- Numeric formatting. Formats a numeric result using Hindi vowels.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.HindiLetter2">
- <summary>
- Numeric formatting. Formats a numeric result using Hindi consonants.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Iroha">
- <summary>
- Numeric formatting. Formats a numeric result using the Japanese iroha.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.KanjiNum1">
- <summary>
- Numeric formatting. Formats a numeric result using a Japanese style using the appropriate counting system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.KanjiNum2">
- <summary>
- Numeric formatting. Formats a numeric result using the appropriate counting system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.KanjiNum3">
- <summary>
- Numeric formatting. Formats a numeric result using the appropriate counting system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Ordinal">
- <summary>
- Numeric formatting. Ordinal (1st, 2nd, 3rd, ...).
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.OrdText">
- <summary>
- Numeric formatting. Ordinal text (First, Second, Third, ...).
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.UppercaseRoman">
- <summary>
- Numeric formatting. Uppercase Roman (I, II, III, ...).
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.LowercaseRoman">
- <summary>
- Numeric formatting. Lowercase Roman (i, ii, iii, ...).
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.SBChar">
- <summary>
- Numeric formatting. Formats a numeric result using single-byte Arabic numbering.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.ThaiArabic">
- <summary>
- Numeric formatting. Formats a numeric result using Thai numbers.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.ThaiCardText">
- <summary>
- Numeric formatting. Formats a numeric result using sequential numbers from the Thai counting system.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.ThaiLetter">
- <summary>
- Numeric formatting. Formats a numeric result using Thai letters.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.VietCardText">
- <summary>
- Numeric formatting. Formats a numeric result using Vietnamese numerals.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Zodiac1">
- <summary>
- Numeric formatting. Formats a numeric result using sequential numerical traditional ideographs.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Zodiac2">
- <summary>
- Numeric formatting. Formats a numeric result using sequential zodiac ideographs.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Zodiac3">
- <summary>
- Numeric formatting. Formats a numeric result using sequential traditional zodiac ideographs.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Caps">
- <summary>
- Text formatting. Capitalizes the first letter of each word.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.FirstCap">
- <summary>
- Text formatting. Capitalizes the first letter of the first word.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Lower">
- <summary>
- Text formatting. All letters are lowercase.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.Upper">
- <summary>
- Text formatting. All letters are uppercase.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.CharFormat">
- <summary>
- Field result formatting. The CHARFORMAT instruction.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.MergeFormat">
- <summary>
- Field result formatting. The MERGEFORMAT instruction.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.GeneralFormat.MergeFormatInet">
- <summary>
- Field result formatting. The MERGEFORMATINET instruction.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.GeneralFormatCollection">
- <summary>
- Represents a typed collection of general formats.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fields.GeneralFormatCollection.Add(Aspose.Words.Fields.GeneralFormat)">
- <summary>
- Adds a general format to the collection.
- </summary>
- <param name="item">A general format.</param>
- </member>
- <member name="M:Aspose.Words.Fields.GeneralFormatCollection.Remove(Aspose.Words.Fields.GeneralFormat)">
- <summary>
- Removes all occurrences of the specified general format from the collection.
- </summary>
- <param name="item">A general format.</param>
- </member>
- <member name="M:Aspose.Words.Fields.GeneralFormatCollection.RemoveAt(System.Int32)">
- <summary>
- Removes a general format occurrence at the specified index.
- </summary>
- <param name="index">
- </param>
- </member>
- <member name="M:Aspose.Words.Fields.GeneralFormatCollection.GetEnumerator">
- <summary>
- Returns an enumerator object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.GeneralFormatCollection.Count">
- <summary>
- Gets the total number of the items in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.GeneralFormatCollection.Item(System.Int32)">
- <summary>
- Gets a general format at the specified index.
- </summary>
- <param name="index">The index of a general format.</param>
- <returns>A general format.</returns>
- </member>
- <member name="T:Aspose.Words.Fields.FieldFormText">
- <summary>
- Implements the FORMTEXT field.
- </summary>
- <remarks>
- Inserts a text box style form field.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FieldFormat">
- <summary>
- Provides typed access to field's numeric, date and time, and general formatting.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldFormat.NumericFormat">
- <summary>
- Gets or sets a formatting that is applied to a numeric field result. Corresponds to the \# switch.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldFormat.DateTimeFormat">
- <summary>
- Gets or sets a formatting that is applied to a date and time field result. Corresponds to the \@ switch.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldFormat.GeneralFormats">
- <summary>
- Gets a collection of general formats that are applied to a numeric, text or any field result.
- Corresponds to the \* switches.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.DropDownItemCollection">
- <summary>
- A collection of strings that represent all the items in a drop-down form field.
- </summary>
- <seealso cref="T:Aspose.Words.Fields.FormField" />
- <seealso cref="P:Aspose.Words.Fields.FormField.DropDownItems" />
- </member>
- <member name="M:Aspose.Words.Fields.DropDownItemCollection.GetEnumerator">
- <summary>
- Returns an enumerator object that can be used to iterate over all items in the collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fields.DropDownItemCollection.Add(System.String)">
- <summary>
- Adds a string to the end of the collection.
- </summary>
- <param name="value">The string to add to the end of the collection.</param>
- <returns>The zero-based index at which the new element is inserted.</returns>
- </member>
- <member name="M:Aspose.Words.Fields.DropDownItemCollection.Contains(System.String)">
- <summary>
- Determines whether the collection contains the specified value.
- </summary>
- <param name="value">Case-sensitive value to locate.</param>
- <returns>True if the item is found in the collection; otherwise, false.</returns>
- </member>
- <member name="M:Aspose.Words.Fields.DropDownItemCollection.IndexOf(System.String)">
- <summary>
- Returns the zero-based index of the specified value in the collection.
- </summary>
- <param name="value">The case-sensitive value to locate.</param>
- <returns>The zero based index. Negative value if not found.</returns>
- </member>
- <member name="M:Aspose.Words.Fields.DropDownItemCollection.Insert(System.Int32,System.String)">
- <summary>
- Inserts a string into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which value is inserted.</param>
- <param name="value">The string to insert.</param>
- </member>
- <member name="M:Aspose.Words.Fields.DropDownItemCollection.Remove(System.String)">
- <summary>
- Removes the specified value from the collection.
- </summary>
- <param name="name">The case-sensitive value to remove.</param>
- </member>
- <member name="M:Aspose.Words.Fields.DropDownItemCollection.RemoveAt(System.Int32)">
- <summary>
- Removes a value at the specified index.
- </summary>
- <param name="index">The zero based index.</param>
- </member>
- <member name="M:Aspose.Words.Fields.DropDownItemCollection.Clear">
- <summary>
- Removes all elements from the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.DropDownItemCollection.Count">
- <summary>
- Gets the number of elements contained in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.DropDownItemCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FormField">
- <summary>
- Represents a single form field.
- </summary>
- <remarks>
- <p>Microsoft Word provides the following form fields: checkbox, text input and dropdown (combobox).</p>
- <p>
- <b>FormField</b> is an inline-node and can only be a child of <b>Paragraph</b>.</p>
- <p>
- <b>FormField</b> is represented in a document by a special character and
- positioned as a character within a line of text.</p>
- <p>A complete form field in a Word document is a complex structure represented by several
- nodes: field start, field code such as FORMTEXT, form field data, field separator,
- field result, field end and a bookmark. To programmatically create form fields in a Word document use
- <see cref="M:Aspose.Words.DocumentBuilder.InsertCheckBox(System.String,System.Boolean,System.Int32)">DocumentBuilder.InsertCheckBox</see>,
- <see cref="M:Aspose.Words.DocumentBuilder.InsertTextInput(System.String,Aspose.Words.Fields.TextFormFieldType,System.String,System.String,System.Int32)">DocumentBuilder.InsertTextInput</see> and
- <see cref="M:Aspose.Words.DocumentBuilder.InsertComboBox(System.String,System.String[],System.Int32)">DocumentBuilder.InsertComboBox</see> which
- make sure all of the form field nodes are created in a correct order and in a suitable state.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.FormField.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Calls DocumentVisitor.VisitFormField.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the node.</param>
- <returns>False if the visitor requested the enumeration to stop.</returns>
- </member>
- <member name="M:Aspose.Words.Fields.FormField.RemoveField">
- <summary>
- Removes the complete form field, not just the form field special character.
- </summary>
- <remarks>
- If there is a bookmark associated with the form field, the bookmark is not removed.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.FormField.SetTextInputValue(System.Object)">
- <summary>
- Applies the text format specified in <see cref="P:Aspose.Words.Fields.FormField.TextInputFormat" /> and stores the value in <see cref="P:Aspose.Words.Fields.FormField.Result" />.
- </summary>
- <param name="newValue">Can be a string, number or a DateTime object.</param>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.NodeType">
- <summary>
- Returns <b>NodeType.FormField</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.Name">
- <summary>
- Gets or sets the form field name.
- </summary>
- <remarks>
- Microsoft Word allows strings with at most 20 characters.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.Type">
- <summary>
- Returns the form field type.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.Result">
- <summary>
- Gets or sets a string that represents the result of this form field.
- </summary>
- <remarks>
- <p>For a text form field the result is the text that is in the field.</p>
- <p>For a checkbox form field the result can be "1" or "0" to indicate checked or unchecked.</p>
- <p>For a dropdown form field the result is the string selected in the dropdown.</p>
- <p>Setting <see cref="P:Aspose.Words.Fields.FormField.Result" /> for a text form field does not apply the text format
- specified in <see cref="P:Aspose.Words.Fields.FormField.TextInputFormat" />. If you want to set a value and apply the
- format, use the <see cref="M:Aspose.Words.Fields.FormField.SetTextInputValue(System.Object)" /> method.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.StatusText">
- <summary>
- Returns or sets the text that's displayed in the status bar when a form field has the focus.
- </summary>
- <remarks>
- <p>If the OwnStatus property is set to true, the StatusText property specifies the status bar text.
- If the OwnStatus property is set to false, the StatusText property specifies the name of an AutoText
- entry that contains status bar text for the form field.</p>
- <p> Microsoft Word allows strings with at most 138 characters.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.OwnStatus">
- <summary>
- Specifies the source of the text that's displayed in the status bar when a form field has the focus.
- </summary>
- <remarks>
- <p>If true, the text specified by the StatusText property is displayed.
- If false, the text of the AutoText entry specified by the StatusText property is displayed.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.HelpText">
- <summary>
- Returns or sets the text that's displayed in a message box when the form field has the focus and the user presses F1.
- </summary>
- <remarks>
- <p>If the OwnHelp property is set to True, HelpText specifies the text string value.
- If OwnHelp is set to False, HelpText specifies the name of an AutoText entry that contains help
- text for the form field.</p>
- <p>Microsoft Word allows strings with at most 255 characters.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.OwnHelp">
- <summary>
- Specifies the source of the text that's displayed in a message box when a form field has the focus and the user presses F1.
- </summary>
- <remarks>
- <p>If True, the text specified by the HelpText property is displayed.
- If False, the text in the AutoText entry specified by the HelpText property is displayed.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.CalculateOnExit">
- <summary>
- True if references to the specified form field are automatically updated whenever the field is exited.
- </summary>
- <remarks>
- <p>Setting <b>CalculateOnExit</b> only affects the behavior of the form field when
- the document is opened in Microsoft Word. Aspose.Words never updates references
- to the form field.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.EntryMacro">
- <summary>
- Returns or sets an entry macro name for the form field.
- </summary>
- <remarks>
- <p>The entry macro runs when the form field gets the focus in Microsoft Word.</p>
- <p>Microsoft Word allows strings with at most 32 characters.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.ExitMacro">
- <summary>
- Returns or sets an exit macro name for the form field.
- </summary>
- <remarks>
- <p>The exit macro runs when the form field loses the focus in Microsoft Word.</p>
- <p>Microsoft Word allows strings with at most 32 characters.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.Enabled">
- <summary>
- True if a form field is enabled.
- </summary>
- <remarks>
- <p>If a form field is enabled, its contents can be changed as the form is filled in.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.TextInputFormat">
- <summary>
- Returns or sets the text formatting for a text form field.
- </summary>
- <remarks>
- <p>If the text form field contains regular text, then valid format strings are
- "", "UPPERCASE", "LOWERCASE", "FIRST CAPITAL" and "TITLE CASE". The strings
- are case-insensitive.</p>
- <p>If the text form field contains a number or a date/time value, then valid
- format strings are number or date and time format strings.</p>
- <p>Microsoft Word allows strings with at most 64 characters.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.TextInputType">
- <summary>
- Gets or sets the type of a text form field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.TextInputDefault">
- <summary>
- Gets or sets the default string or a calculation expression of a text form field.
- </summary>
- <remarks>
- <para>The meaning of this property depends on the value of the <see cref="P:Aspose.Words.Fields.FormField.TextInputType" /> property.</para>
- <para>When <see cref="P:Aspose.Words.Fields.FormField.TextInputType" /> is <see cref="F:Aspose.Words.Fields.TextFormFieldType.Regular" /> or
- <see cref="F:Aspose.Words.Fields.TextFormFieldType.Number" />, this string specifies the default string for the text form field.
- This string is the content that Microsoft Word will display in the document when the form field is empty.</para>
- <para>When <see cref="P:Aspose.Words.Fields.FormField.TextInputType" /> is <see cref="F:Aspose.Words.Fields.TextFormFieldType.Calculated" />, then this string holds
- the expression to be calculated. The expression needs to be a formula valid according to Microsoft Word formula field
- requirements. When you set a new expression using this property, Aspose.Words calculates the formula result
- automatically and inserts it into the form field.</para>
- <para>Microsoft Word allows strings with at most 255 characters.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.MaxLength">
- <summary>
- Maximum length for the text field. Zero when the length is not limited.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.DropDownItems">
- <summary>
- Provides access to the items of a dropdown form field.
- </summary>
- <remarks>
- <p>Microsoft Word allows maximum 25 items in a dropdown form field.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.DropDownSelectedIndex">
- <summary>
- Gets or sets the index specifying the currently selected item in a dropdown form field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.Checked">
- <summary>
- Gets or sets the checked status of the check box form field.
- Default value for this property is <b>false</b>.
- </summary>
- <remarks>
- <p>Applicable for a check box form field only.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.Default">
- <summary>
- Gets or sets the default value of the check box form field.
- Default value for this property is <b>false</b>.
- </summary>
- <remarks>
- <p>Applicable for a check box form field only.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.IsCheckBoxExactSize">
- <summary>
- Gets or sets the boolean value that indicates whether the size of the textbox is automatic or specified explicitly.
- </summary>
- <remarks>
- <p>Applicable for a check box form field only.</p>
- <seealso cref="P:Aspose.Words.Fields.FormField.CheckBoxSize" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.FormField.CheckBoxSize">
- <summary>
- Gets or sets the size of the checkbox in points. Has effect only when <see cref="P:Aspose.Words.Fields.FormField.IsCheckBoxExactSize" /> is true.
- </summary>
- <remarks>
- <p>Applicable for a check box form field only.</p>
- <seealso cref="P:Aspose.Words.Fields.FormField.IsCheckBoxExactSize" />
- </remarks>
- </member>
- <member name="T:Aspose.Words.Fields.FormFieldCollection">
- <summary>
- A collection of <b>FormField</b> objects that represent all the form fields in a range.
- </summary>
- <dev>Facade wrapper for a collection of form field objects.</dev>
- </member>
- <member name="M:Aspose.Words.Fields.FormFieldCollection.Remove(System.String)">
- <summary>
- Removes a form field with the specified name.
- </summary>
- <remarks>
- If there is a bookmark associated with the form field, the bookmark is not removed.
- </remarks>
- <param name="formField">The case-insensitive name of the form field to remove.</param>
- </member>
- <member name="M:Aspose.Words.Fields.FormFieldCollection.RemoveAt(System.Int32)">
- <summary>
- Removes a form field at the specified index.
- </summary>
- <remarks>
- If there is a bookmark associated with the form field, the bookmark is not removed.
- </remarks>
- <param name="index">The zero-based index of the form field to remove.</param>
- </member>
- <member name="M:Aspose.Words.Fields.FormFieldCollection.Clear">
- <summary>
- Removes all form fields from this collection and from the document.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fields.FormFieldCollection.GetEnumerator">
- <summary>
- Returns an enumerator object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FormFieldCollection.Count">
- <summary>
- Returns the number of form fields in the collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FormFieldCollection.Item(System.Int32)">
- <summary>
- Returns a form field at the specified index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the collection.</param>
- </member>
- <member name="P:Aspose.Words.Fields.FormFieldCollection.Item(System.String)">
- <summary>
- Returns a form field by bookmark name.
- </summary>
- <remarks>
- Returns null if the form field with the specified bookmark name cannot be found.
- </remarks>
- <param name="bookmarkName">Case-insensitive bookmark name.</param>
- </member>
- <member name="T:Aspose.Words.Fields.TextFormFieldType">
- <summary>
- Specifies the type of a text form field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.TextFormFieldType.Regular">
- <summary>
- The text form field can contain any text.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.TextFormFieldType.Number">
- <summary>
- The text form field can contain only numbers.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.TextFormFieldType.Date">
- <summary>
- The text form field can contain only a valid date value.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.TextFormFieldType.CurrentDate">
- <summary>
- The text form field value is the current date when the field is updated.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.TextFormFieldType.CurrentTime">
- <summary>
- The text form field value is the current time when the field is updated.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.TextFormFieldType.Calculated">
- <summary>
- The text form field value is calculated from the expression specified in
- the <see cref="P:Aspose.Words.Fields.FormField.TextInputDefault" /> property.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldChar">
- <summary>
- Base class for nodes that represent field characters in a document.
- </summary>
- <remarks>
- <p>A complete field in a Microsoft Word document is a complex structure consisting of
- a field start character, field code, field separator character, field result
- and field end character. Some fields only have field start, field code and field end.</p>
- <p>To easily insert a new field into a document, use the <see cref="M:Aspose.Words.DocumentBuilder.InsertField(System.String)" />
- method.</p>
- </remarks>
- <seealso cref="T:Aspose.Words.Fields.FieldStart" />
- <seealso cref="T:Aspose.Words.Fields.FieldSeparator" />
- <seealso cref="T:Aspose.Words.Fields.FieldEnd" />
- </member>
- <member name="M:Aspose.Words.Fields.FieldChar.GetField">
- <summary>
- Returns a field for the field char.
- </summary>
- <remarks>
- A new <see cref="T:Aspose.Words.Fields.Field" /> object is created each time the method is called.
- </remarks>
- <returns>A field for the field char.</returns>
- </member>
- <member name="P:Aspose.Words.Fields.FieldChar.FieldType">
- <summary>
- Returns the type of the field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldChar.IsLocked">
- <summary>
- Gets or sets whether the parent field is locked (should not recalculate its result).
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldChar.IsDirty">
- <summary>
- Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications
- made to the document.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldEnd">
- <summary>
- Represents an end of a Word field in a document.
- </summary>
- <remarks>
- <p>
- <see cref="T:Aspose.Words.Fields.FieldEnd" /> is an inline-level node and represented
- by the <see cref="F:Aspose.Words.ControlChar.FieldEndChar" /> control character in the document.</p>
- <p>
- <see cref="T:Aspose.Words.Fields.FieldEnd" /> can only be a child of <see cref="T:Aspose.Words.Paragraph" />.</p>
- <p>A complete field in a Microsoft Word document is a complex structure consisting of
- a field start character, field code, field separator character, field result
- and field end character. Some fields only have field start, field code and field end.</p>
- <p>To easily insert a new field into a document, use the <see cref="M:Aspose.Words.DocumentBuilder.InsertField(System.String)" />
- method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.FieldEnd.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitFieldEnd(Aspose.Words.Fields.FieldEnd)" />.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the node.</param>
- <returns>
- <b>False</b> if the visitor requested the enumeration to stop.</returns>
- </member>
- <member name="P:Aspose.Words.Fields.FieldEnd.NodeType">
- <summary>
- Returns <see cref="F:Aspose.Words.NodeType.FieldEnd" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.FieldEnd.HasSeparator">
- <summary>
- Returns <b>true</b> if this field has a separator.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldSeparator">
- <summary>
- Represents a Word field separator that separates the field code from the field result.
- </summary>
- <remarks>
- <p>
- <see cref="T:Aspose.Words.Fields.FieldSeparator" /> is an inline-level node and represented
- by the <see cref="F:Aspose.Words.ControlChar.FieldSeparatorChar" /> control character in the document.</p>
- <p>
- <see cref="T:Aspose.Words.Fields.FieldSeparator" /> can only be a child of <see cref="T:Aspose.Words.Paragraph" />.</p>
- <p>A complete field in a Microsoft Word document is a complex structure consisting of
- a field start character, field code, field separator character, field result
- and field end character. Some fields only have field start, field code and field end.</p>
- <p>To easily insert a new field into a document, use the <see cref="M:Aspose.Words.DocumentBuilder.InsertField(System.String)" />
- method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.FieldSeparator.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitFieldSeparator(Aspose.Words.Fields.FieldSeparator)" />.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the node.</param>
- <returns>
- <b>False</b> if the visitor requested the enumeration to stop.</returns>
- </member>
- <member name="P:Aspose.Words.Fields.FieldSeparator.NodeType">
- <summary>
- Returns <see cref="F:Aspose.Words.NodeType.FieldSeparator" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.FieldStart">
- <summary>
- Represents a start of a Word field in a document.
- </summary>
- <remarks>
- <p>
- <see cref="T:Aspose.Words.Fields.FieldStart" /> is an inline-level node and represented by the
- <see cref="F:Aspose.Words.ControlChar.FieldStartChar" /> control character in the document.</p>
- <p>
- <see cref="T:Aspose.Words.Fields.FieldStart" /> can only be a child of <see cref="T:Aspose.Words.Paragraph" />.</p>
- <p>A complete field in a Microsoft Word document is a complex structure consisting of
- a field start character, field code, field separator character, field result
- and field end character. Some fields only have field start, field code and field end.</p>
- <p>To easily insert a new field into a document, use the <see cref="M:Aspose.Words.DocumentBuilder.InsertField(System.String)" />
- method.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.FieldStart.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitFieldStart(Aspose.Words.Fields.FieldStart)" />.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the node.</param>
- <returns>
- <b>False</b> if the visitor requested the enumeration to stop.</returns>
- </member>
- <member name="P:Aspose.Words.Fields.FieldStart.NodeType">
- <summary>
- Returns <see cref="F:Aspose.Words.NodeType.FieldStart" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.NamespaceDoc">
- <summary>
- <p>The <b>Aspose.Words.Fields</b> namespace contains classes that
- represent Microsoft Word fields in a document.</p>
- </summary>
- </member>
- <member name="T:Aspose.Words.Fields.Field">
- <summary>
- Represents a Microsoft Word document field.
- </summary>
- <remarks>
- <para>A field in a Word document is a complex structure consisting of multiple nodes that include field start,
- field code, field separator, field result and field end. Fields can be nested, contain rich content and span
- multiple paragraphs or sections in a document. The <see cref="T:Aspose.Words.Fields.Field" /> class is a "facade" object that provides
- properties and methods that allow to work with a field as a single object. </para>
- <para>The <see cref="P:Aspose.Words.Fields.Field.Start" />, <see cref="P:Aspose.Words.Fields.Field.Separator" /> and <see cref="P:Aspose.Words.Fields.Field.End" /> properties point to the
- field start, separator and end nodes of the field respectively.</para>
- <para>The content between the field start and separator is the field code. The content between the
- field separator and field end is the field result. The field code typically consists of one or more
- <see cref="T:Aspose.Words.Run" /> objects that specify instructions. The processing application is expected to execute
- the field code to calculate the field result.</para>
- <para>The process of calculating field results is called the field update. Aspose.Words can update field
- results of most of the field types in exactly the same way as Microsoft Word does it. Most notably,
- Aspose.Words can calculate results of even the most complex formula fields. To calculate the field
- result of a single field use the <see cref="M:Aspose.Words.Fields.Field.Update" /> method. To update fields in the whole document
- use <see cref="M:Aspose.Words.Document.UpdateFields" />.</para>
- <para>You can get the plain text version of the field code using the <see cref="M:Aspose.Words.Fields.Field.GetFieldCode(System.Boolean)" /> method.
- You can get and set the plain text version of the field result using the <see cref="P:Aspose.Words.Fields.Field.Result" /> property.
- Both the field code and field result can contain complex content, such as nested fields, paragraphs, shapes,
- tables and in this case you might want to work with the field nodes directly if you need more control.</para>
- <para>You do not create instances of the <see cref="T:Aspose.Words.Fields.Field" /> class directly.
- To create a new field use the <see cref="M:Aspose.Words.DocumentBuilder.InsertField(System.String)" /> method.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Fields.Field.GetFieldCode">
- <summary>
- Returns text between field start and field separator (or field end if there is no separator).
- Both field code and field result of child fields are included.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fields.Field.GetFieldCode(System.Boolean)">
- <summary>
- Returns text between field start and field separator (or field end if there is no separator).
- </summary>
- <param name="includeChildFieldCodes">
- <c>True</c> if child field codes should be included.
- </param>
- </member>
- <member name="M:Aspose.Words.Fields.Field.Remove">
- <summary>
- Removes the field from the document. Returns a node right after the field. If the field's end is the last child
- of its parent node, returns its parent paragraph. If the field is already removed, returns <b>null</b>.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fields.Field.Remove(Aspose.Words.Fields.FieldArea)">
- <summary>
- Removes field code or result.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fields.Field.Update">
- <summary>
- Performs the field update. Throws if the field is being updated already.
- </summary>
- </member>
- <member name="M:Aspose.Words.Fields.Field.Update(System.Boolean)">
- <summary>
- Performs a field update. Throws if the field is being updated already.
- </summary>
- <param name="ignoreMergeFormat">
- If <c>true</c> then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.
- </param>
- </member>
- <member name="M:Aspose.Words.Fields.Field.Unlink">
- <summary>
- Performs the field unlink.
- </summary>
- <remarks>
- <para>Replaces the field with its most recent result.</para>
- <para>Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.</para>
- </remarks>
- <returns>
- <c>True</c> if the field has been unlinked, otherwise <c>false</c>.
- </returns>
- </member>
- <member name="P:Aspose.Words.Fields.Field.Start">
- <summary>
- Gets the node that represents the start of the field.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.Field.Separator">
- <summary>
- Gets the node that represents the field separator. Can be null.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.Field.End">
- <summary>
- Gets the node that represents the field end.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.Field.Type">
- <summary>
- Gets the Microsoft Word field type.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.Field.Result">
- <summary>
- Gets or sets text that is between the field separator and field end.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.Field.DisplayResult">
- <summary>
- Gets the text that represents the displayed field result.
- </summary>
- <remarks>
- The <see cref="M:Aspose.Words.Document.UpdateListLabels" /> method must be called to obtain correct value for the
- <see cref="T:Aspose.Words.Fields.FieldListNum" />, <see cref="T:Aspose.Words.Fields.FieldAutoNum" />, <see cref="T:Aspose.Words.Fields.FieldAutoNumOut" /> and <see cref="T:Aspose.Words.Fields.FieldAutoNumLgl" /> fields.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Fields.Field.IsLocked">
- <summary>
- Gets or sets whether the field is locked (should not recalculate its result).
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.Field.IsDirty">
- <summary>
- Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.Field.Format">
- <summary>
- Gets a <see cref="T:Aspose.Words.Fields.FieldFormat" /> object that provides typed access to field's formatting.
- </summary>
- </member>
- <member name="P:Aspose.Words.Fields.Field.LocaleId">
- <summary>
- Gets or sets the LCID of the field.
- </summary>
- <seealso cref="F:Aspose.Words.Fields.FieldUpdateCultureSource.FieldCode" />
- </member>
- <member name="T:Aspose.Words.Fields.FieldType">
- <summary>
- Specifies Microsoft Word field types.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldNone">
- <summary>
- Field type is not specified or unknown.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldCannotParse">
- <summary>
- Specifies that the field was unable to be parsed.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldAddin">
- <summary>
- Specifies the ADDIN field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldAddressBlock">
- <summary>
- Specifies the ADDRESSBLOCK field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldAdvance">
- <summary>
- Specifies the ADVANCE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldAsk">
- <summary>
- Specifies the ASK field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldAuthor">
- <summary>
- Specifies the AUTHOR field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldAutoNum">
- <summary>
- Specifies the AUTONUM field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldAutoNumLegal">
- <summary>
- Specifies the AUTONUMLGL field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldAutoNumOutline">
- <summary>
- Specifies the AUTONUMOUT field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldAutoText">
- <summary>
- Specifies the AUTOTEXT field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldAutoTextList">
- <summary>
- Specifies the AUTOTEXTLIST field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldBarcode">
- <summary>
- Specifies the BARCODE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldBibliography">
- <summary>
- Specifies the BIBLIOGRAPHY field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldBidiOutline">
- <summary>
- Specifies the BIDIOUTLINE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldCitation">
- <summary>
- Specifies the CITATION field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldComments">
- <summary>
- Specifies the COMMENTS field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldCompare">
- <summary>
- Specifies the COMPARE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldCreateDate">
- <summary>
- Specifies the CREATEDATE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldData">
- <summary>
- Specifies the DATA field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldDatabase">
- <summary>
- Specifies the DATABASE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldDate">
- <summary>
- Specifies the DATE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldDDE">
- <summary>
- Specifies the DDE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldDisplayBarcode">
- <summary>
- Specifies the DISPLAYBARCODE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldMergeBarcode">
- <summary>
- Specifies the MERGEBARCODE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldDDEAuto">
- <summary>
- Specifies the DDEAUTO field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldDocProperty">
- <summary>
- Specifies the DOCPROPERTY field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldDocVariable">
- <summary>
- Specifies the DOCVARIABLE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldEditTime">
- <summary>
- Specifies the EDITTIME field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldEmbed">
- <summary>
- Specifies the EMBED field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldEquation">
- <summary>
- Specifies the EQ field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldFileName">
- <summary>
- Specifies the FILENAME field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldFileSize">
- <summary>
- Specifies the FILESIZE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldFillIn">
- <summary>
- Specifies the FILLIN field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldFootnoteRef">
- <summary>
- Specifies the FOOTNOTEREF field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldFormCheckBox">
- <summary>
- Specifies the FORMCHECKBOX field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldFormDropDown">
- <summary>
- Specifies the FORMDROPDOWN field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldFormTextInput">
- <summary>
- Specifies the FORMTEXT field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldFormula">
- <summary>
- Specifies the = (formula) field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldGreetingLine">
- <summary>
- Specifies the GREETINGLINE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldGlossary">
- <summary>
- Specifies the GLOSSARY field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldGoToButton">
- <summary>
- Specifies the GOTOBUTTON field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldHtmlActiveX">
- <summary>
- Specifies the field that represents an HTML control.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldHyperlink">
- <summary>
- Specifies the HYPERLINK field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldIf">
- <summary>
- Specifies the IF field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldInclude">
- <summary>
- Specifies the INCLUDE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldIncludePicture">
- <summary>
- Specifies the INCLUDEPICTURE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldIncludeText">
- <summary>
- Specifies the INCLUDETEXT field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldIndex">
- <summary>
- Specifies the INDEX field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldIndexEntry">
- <summary>
- Specifies the XE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldInfo">
- <summary>
- Specifies the INFO field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldImport">
- <summary>
- Specifies the IMPORT field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldKeyword">
- <summary>
- Specifies the KEYWORDS field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldLastSavedBy">
- <summary>
- Specifies the LASTSAVEDBY field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldLink">
- <summary>
- Specifies the LINK field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldListNum">
- <summary>
- Specifies the LISTNUM field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldMacroButton">
- <summary>
- Specifies the MACROBUTTON field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldMergeField">
- <summary>
- Specifies the MERGEFIELD field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldMergeRec">
- <summary>
- Specifies the MERGEREC field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldMergeSeq">
- <summary>
- Specifies the MERGESEQ field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldNext">
- <summary>
- Specifies the NEXT field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldNextIf">
- <summary>
- Specifies the NEXTIF field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldNoteRef">
- <summary>
- Specifies the NOTEREF field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldNumChars">
- <summary>
- Specifies the NUMCHARS field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldNumPages">
- <summary>
- Specifies the NUMPAGES field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldNumWords">
- <summary>
- Specifies the NUMWORDS field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldOcx">
- <summary>
- <p>Specifies the OCX field.</p>
- <p>Normally, Aspose.Words will represent an ActiveX control as a
- <see cref="T:Aspose.Words.Drawing.Shape" /> object, but for some documents, where a control does
- not have data and/or seems to be invalid, it will be represented as a field.</p>
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldPage">
- <summary>
- Specifies the PAGE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldPageRef">
- <summary>
- Specifies the PAGEREF field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldPrint">
- <summary>
- Specifies the PRINT field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldPrintDate">
- <summary>
- Specifies the PRINTDATE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldPrivate">
- <summary>
- Specifies the PRIVATE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldQuote">
- <summary>
- Specifies the QUOTE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldRef">
- <summary>
- Specifies the REF field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldRefNoKeyword">
- <summary>
- Specifies that the field represents a REF field where the keyword has been omitted.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldRefDoc">
- <summary>
- Specifies the RD field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldRevisionNum">
- <summary>
- Specifies the REVNUM field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldSaveDate">
- <summary>
- Specifies the SAVEDATE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldSection">
- <summary>
- Specifies the SECTION field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldSectionPages">
- <summary>
- Specifies the SECTIONPAGES field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldSequence">
- <summary>
- Specifies the SEQ field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldSet">
- <summary>
- Specifies the SET field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldShape">
- <summary>
- Specifies the SHAPE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldSkipIf">
- <summary>
- Specifies the SKIPIF field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldStyleRef">
- <summary>
- Specifies the STYLEREF field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldSubject">
- <summary>
- Specifies the SUBJECT field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldSymbol">
- <summary>
- Specifies the SYMBOL field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldTemplate">
- <summary>
- Specifies the TEMPLATE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldTime">
- <summary>
- Specifies the TIME field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldTitle">
- <summary>
- Specifies the TITLE field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldTOA">
- <summary>
- Specifies the TOA field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldTOAEntry">
- <summary>
- Specifies the TA field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldTOC">
- <summary>
- Specifies the TOC field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldTOCEntry">
- <summary>
- Specifies the TC field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldUserAddress">
- <summary>
- Specifies the USERADDRESS field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldUserInitials">
- <summary>
- Specifies the USERINITIALS field.
- </summary>
- </member>
- <member name="F:Aspose.Words.Fields.FieldType.FieldUserName">
- <summary>
- Specifies the USERNAME field.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.HorizontalRuleFormat">
- <summary>
- Represents horizontal rule formatting.
- </summary>
- <dev>
- FIX 18182. This class has been added to provide public horizontal rule properties.
- </dev>
- </member>
- <member name="P:Aspose.Words.Drawing.HorizontalRuleFormat.WidthPercent">
- <summary>
- Gets or sets the length of the specified horizontal rule expressed as a percentage of the window width.
- </summary>
- <remarks>
- <p>Valid values range from 1 to 100 inclusive.</p>
- <p>The default value is 100.</p>
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Throws when argument was out of the range of valid values.
- </exception>
- </member>
- <member name="P:Aspose.Words.Drawing.HorizontalRuleFormat.Height">
- <summary>
- Gets or sets the height of the horizontal rule.
- </summary>
- <remarks>
- <p>This is a shortcut to the <see cref="P:Aspose.Words.Drawing.ShapeBase.Height" /> property.</p>
- <p>Valid values range from 0 to 1584 inclusive.</p>
- <p>The default value is 1.5.</p>
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Throws when argument was out of the range of valid values.
- </exception>
- </member>
- <member name="P:Aspose.Words.Drawing.HorizontalRuleFormat.NoShade">
- <summary>
- Indicates the presence of 3D shading for the horizontal rule.
- If true, then the horizontal rule is without 3D shading and solid color is used.
- </summary>
- <remarks>
- <p>The default value is false.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.HorizontalRuleFormat.Color">
- <summary>
- Gets or sets the brush color that fills the horizontal rule.
- </summary>
- <remarks>
- <p>This is a shortcut to the <see cref="P:Aspose.Words.Drawing.Fill.Color" /> property.</p>
- <p>The default value is
- <see cref="P:System.Drawing.Color.Gray" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.HorizontalRuleFormat.Alignment">
- <summary>
- Gets or sets the alignment of the horizontal rule.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.HorizontalRuleAlignment.Left" />.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Drawing.OlePackage">
- <summary>
- Allows to access OLE Package properties.
- </summary>
- <remarks>
- OLE package is a legacy and "undocumented" way to store embedded object if OLE handler is unknown.
- Early Windows versions such as Windows 3.1, 95 and 98 had Packager.exe application which could be used to embed any type of data into document.
- Now this application is excluded from Windows but MS Word and other applications still use it to embed data if OLE handler is missing or unknown.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.OlePackage.FileName">
- <summary>
- Gets or sets OLE Package file name.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.OlePackage.DisplayName">
- <summary>
- Gets or sets OLE Package display name.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.NamespaceDoc">
- <summary>
- <para>The <b>Aspose.Words.Drawing</b> namespace provides classes that allow to create and modify drawing objects.</para>
- <para>All drawing objects in in Microsoft Word documents are represented by instances of the <see cref="T:Aspose.Words.Drawing.Shape" /> and <see cref="T:Aspose.Words.Drawing.GroupShape" /> classes.
- An object of the <see cref="T:Aspose.Words.Drawing.Shape" /> class is a node in a document and can represent a picture, textbox, AutoShape or an OLE object.</para>
- <para>The classes in this namespace support the latest (Word 2007 - 2013 DrawingML) and the earlier (pre Word 2007 - Office Art) shapes.</para>
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.ShapeMarkupLanguage">
- <summary>
- Specifies Markup language used for the shape.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeMarkupLanguage.Dml">
- <summary>
- Drawing Markup Language is used to define the shape.
- </summary>
- <remarks>
- This is the new standard for drawing for Office Open XML which has appeared first in ECMA-376 1st edition (2006), first appeared in MS Word 2007.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeMarkupLanguage.Vml">
- <summary>
- Vector Markup Language is used to define the shape.
- </summary>
- <remarks>A deprecated format included in Office Open XML for legacy reasons only.</remarks>
- </member>
- <member name="T:Aspose.Words.Drawing.SignatureLine">
- <summary>
- Provides access to signature line properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.SignatureLine.Signer">
- <summary>
- Gets or sets suggested signer of the signature line.
- Default value for this property is <b>empty string</b> (<see cref="F:System.String.Empty" />).
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.SignatureLine.SignerTitle">
- <summary>
- Gets or sets suggested signer's title (for example, Manager).
- Default value for this property is <b>empty string</b> (<see cref="F:System.String.Empty" />).
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.SignatureLine.Email">
- <summary>
- Gets or sets suggested signer's e-mail address.
- Default value for this property is <b>empty string</b> (<see cref="F:System.String.Empty" />).
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.SignatureLine.DefaultInstructions">
- <summary>
- Gets or sets a value indicating that default instructions is shown in the Sign dialog.
- Default value for this property is <b>true</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.SignatureLine.Instructions">
- <summary>
- Gets or sets instructions to the signer that are displayed on signing the signature line.
- This property is ignored if <see cref="P:Aspose.Words.Drawing.SignatureLine.DefaultInstructions" /> is set.
- Default value for this property is <b>empty string</b> (<see cref="F:System.String.Empty" />).
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.SignatureLine.AllowComments">
- <summary>
- Gets or sets a value indicating that the signer can add comments in the Sign dialog.
- Default value for this property is <b>false</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.SignatureLine.ShowDate">
- <summary>
- Gets or sets a value indicating that sign date is shown in the signature line.
- Default value for this property is <b>true</b>.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.SignatureLine.Id">
- <summary>
- Gets or sets identifier for this signature line.
- <p>This identifier can be associated with a digital signature, when signing document using <see cref="T:Aspose.Words.DigitalSignatureUtil" />.
- This value must be unique and by default it is randomly generated new Guid (<see cref="M:System.Guid.NewGuid" />).</p></summary>
- </member>
- <member name="P:Aspose.Words.Drawing.SignatureLine.ProviderId">
- <summary>
- Gets or sets signature provider identifier for this signature line.
- Default value is "{00000000-0000-0000-0000-000000000000}".
- </summary>
- <remarks>
- <para>The cryptographic service provider (CSP) is an independent software module that actually performs
- cryptography algorithms for authentication, encoding, and encryption. MS Office reserves the value
- of {00000000-0000-0000-0000-000000000000} for its default signature provider.</para>
- <para>The GUID of the additionally installed provider should be obtained from the documentation shipped with the provider.</para>
- <para>In addition, all the installed cryptographic providers are enumerated in windows registry.
- It can be found in the following path: HKLM\SOFTWARE\Microsoft\Cryptography\Defaults\Provider.
- There is a key name "CP Service UUID" which corresponds to a GUID of signature provider.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.SignatureLine.IsSigned">
- <summary>
- Indicates that signature line is signed by digital signature.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.SignatureLine.IsValid">
- <summary>
- Indicates that signature line is signed by digital signature and this digital signature is valid.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.ArrowLength">
- <summary>
- Length of the arrow at the end of a line.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.Stroke.StartArrowLength" />
- <seealso cref="P:Aspose.Words.Drawing.Stroke.EndArrowLength" />
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowLength.Short">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowLength.Medium">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowLength.Long">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowLength.Default">
- <summary>
- Same as <see cref="F:Aspose.Words.Drawing.ArrowLength.Short" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.ArrowType">
- <summary>
- Specifies the type of an arrow at a line end.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.Stroke.StartArrowType" />
- <seealso cref="P:Aspose.Words.Drawing.Stroke.EndArrowType" />
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowType.None">
- <summary>
- The line does not have an arrow at the end.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowType.Arrow">
- <summary>
- The arrow is a solid triangle.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowType.Stealth">
- <summary>
- The arrow is a "stealth" arrow.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowType.Diamond">
- <summary>
- The line end is a solid diamond.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowType.Oval">
- <summary>
- The line end is a solid oval.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowType.Open">
- <summary>
- The arrow is an open arrow.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowType.Default">
- <summary>
- Same as <see cref="F:Aspose.Words.Drawing.ArrowType.None" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.ArrowWidth">
- <summary>
- Width of the arrow at the end of a line.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.Stroke.StartArrowWidth" />
- <seealso cref="P:Aspose.Words.Drawing.Stroke.EndArrowWidth" />
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowWidth.Narrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowWidth.Medium">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowWidth.Wide">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ArrowWidth.Default">
- <summary>
- Same as <see cref="F:Aspose.Words.Drawing.ArrowWidth.Narrow" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.DashStyle">
- <summary>
- Dashed line style.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.Stroke.DashStyle" />
- </member>
- <member name="F:Aspose.Words.Drawing.DashStyle.Solid">
- <summary>
- Solid (continuous) pen.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.DashStyle.ShortDash">
- <summary>
- System dash style.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.DashStyle.ShortDot">
- <summary>
- System dash style.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.DashStyle.ShortDashDot">
- <summary>
- System dash style.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.DashStyle.ShortDashDotDot">
- <summary>
- System dash style.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.DashStyle.Dot">
- <summary>
- Square dot style.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.DashStyle.Dash">
- <summary>
- Dash style.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.DashStyle.LongDash">
- <summary>
- Long dash style.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.DashStyle.DashDot">
- <summary>
- Dash short dash.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.DashStyle.LongDashDot">
- <summary>
- Long dash short dash.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.DashStyle.LongDashDotDot">
- <summary>
- Long dash short dash short dash.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.DashStyle.Default">
- <summary>
- Same as <see cref="F:Aspose.Words.Drawing.DashStyle.Solid" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.EndCap">
- <summary>
- Specifies line cap style.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.Stroke.EndCap" />
- </member>
- <member name="F:Aspose.Words.Drawing.EndCap.Round">
- <summary>
- Rounded ends.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.EndCap.Square">
- <summary>
- Square protrudes by half line width.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.EndCap.Flat">
- <summary>
- Line ends at end point.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.EndCap.Default">
- <summary>
- Default value is <see cref="F:Aspose.Words.Drawing.EndCap.Flat" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Fill">
- <summary>
- Defines a fill for a shape.
- </summary>
- <remarks>
- <p>Use the <see cref="P:Aspose.Words.Drawing.Shape.Fill" /> property to access fill properties of a shape.
- You do not create instances of the <see cref="T:Aspose.Words.Drawing.Fill" /> class directly.</p>
- <p>Although the <see cref="T:Aspose.Words.Drawing.Fill" /> class provides properties to specify solid color fill only,
- all of the more complex fill types, including as gradient, pattern and texture are fully preserved
- during document open-save cycles.</p>
- <seealso cref="P:Aspose.Words.Drawing.Shape.Fill" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Fill.Color">
- <summary>
- Defines the color of a fill.
- </summary>
- <remarks>
- <p>The default value is
- <see cref="P:System.Drawing.Color.White" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Fill.Opacity">
- <summary>
- Defines the transparency of a fill. Valid range from 0 to 1, where 0 is fully transparent and 1 is fully opaque.
- </summary>
- <remarks>
- <p>The default value is 1.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Fill.On">
- <summary>
- Determines whether the shape will be filled.
- </summary>
- <remarks>
- <p>The default value is <b>true</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Fill.ImageBytes">
- <summary>
- Gets the raw bytes of the fill texture or pattern.
- </summary>
- <remarks>
- <p>The default value is null.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Drawing.FlipOrientation">
- <summary>
- Possible values for the orientation of a shape.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.ShapeBase.FlipOrientation" />
- </member>
- <member name="F:Aspose.Words.Drawing.FlipOrientation.None">
- <summary>
- Coordinates are not flipped.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.FlipOrientation.Horizontal">
- <summary>
- Flip along the y-axis, reversing the x-coordinates.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.FlipOrientation.Vertical">
- <summary>
- Flip along the x-axis, reversing the y-coordinates.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.FlipOrientation.Both">
- <summary>
- Flip along both the y- and x-axis.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.GroupShape">
- <summary>
- Represents a group of shapes in a document.
- </summary>
- <remarks>
- <p>A <see cref="T:Aspose.Words.Drawing.GroupShape" /> is a composite node and can have <see cref="T:Aspose.Words.Drawing.Shape" /> and
- <see cref="T:Aspose.Words.Drawing.GroupShape" /> nodes as children.</p>
- <p>Each <see cref="T:Aspose.Words.Drawing.GroupShape" /> defines a new coordinate system for its child shapes.
- The coordinate system is defined using the <see cref="P:Aspose.Words.Drawing.ShapeBase.CoordSize" /> and
- <see cref="P:Aspose.Words.Drawing.ShapeBase.CoordOrigin" /> properties.</p>
- <seealso cref="T:Aspose.Words.Drawing.ShapeBase" />
- <seealso cref="T:Aspose.Words.Drawing.Shape" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.GroupShape.#ctor(Aspose.Words.DocumentBase)">
- <summary>
- Creates a new group shape.
- </summary>
- <param name="doc">The owner document.</param>
- <remarks>
- <p>By default, the shape is floating and has default location and size.</p>
- <p>You should specify desired shape properties after you created a shape.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.GroupShape.#ctor(Aspose.Words.DocumentBase,Aspose.Words.Drawing.ShapeMarkupLanguage)">
- <summary>
- Creates a new group shape.
- </summary>
- <param name="doc">The owner document.</param>
- <param name="markupLanguage">Shape markup language: DrawingML or Vml</param>
- <remarks>
- <p>By default, the shape is floating and has default location and size.</p>
- <p>You should specify desired shape properties after you created a shape.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.GroupShape.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitGroupShapeStart(Aspose.Words.Drawing.GroupShape)" />, then calls <see cref="M:Aspose.Words.Node.Accept(Aspose.Words.DocumentVisitor)" /> for all
- child shapes of this group shape and calls <see cref="M:Aspose.Words.DocumentVisitor.VisitGroupShapeEnd(Aspose.Words.Drawing.GroupShape)" /> at the end.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.GroupShape.NodeType">
- <summary>
- Returns <see cref="F:Aspose.Words.NodeType.GroupShape" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.HorizontalAlignment">
- <summary>
- Specifies horizontal alignment of a floating shape, text frame or floating table.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.ShapeBase.HorizontalAlignment" />
- <dev>
- Do not renumber. The values are taken from the RTF specification.
- </dev>
- </member>
- <member name="F:Aspose.Words.Drawing.HorizontalAlignment.None">
- <summary>
- The object is explicitly positioned, usually using its <b>Left</b> property.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.HorizontalAlignment.Default">
- <summary>
- Same as <see cref="F:Aspose.Words.Drawing.HorizontalAlignment.None" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.HorizontalAlignment.Left">
- <summary>
- Specifies that the object shall be left aligned to the horizontal alignment base.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.HorizontalAlignment.Center">
- <summary>
- Specifies that the object shall be centered with respect to the horizontal alignment base.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.HorizontalAlignment.Right">
- <summary>
- Specifies that the object shall be right aligned to the horizontal alignment base.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.HorizontalAlignment.Inside">
- <summary>
- Specifies that the object shall be inside of the horizontal alignment base.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.HorizontalAlignment.Outside">
- <summary>
- Specifies that the object shall be outside of the horizontal alignment base.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.HorizontalRuleAlignment">
- <summary>
- Represents the alignment for the specified horizontal rule.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.HorizontalRuleAlignment.Left">
- <summary>
- Aligned to the left.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.HorizontalRuleAlignment.Center">
- <summary>
- Aligned to the center.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.HorizontalRuleAlignment.Right">
- <summary>
- Aligned to the right.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.ImageData">
- <summary>
- Defines an image for a shape.
- </summary>
- <remarks>
- <p>Use the <see cref="P:Aspose.Words.Drawing.Shape.ImageData" /> property to access and modify the image inside a shape.
- You do not create instances of the <see cref="T:Aspose.Words.Drawing.ImageData" /> class directly.</p>
- <p>An image can be stored inside a shape, linked to external file or both (linked and stored in the document).</p>
- <p>Regardless of whether the image is stored inside the shape or linked, you can always access the actual
- image using the <see cref="M:Aspose.Words.Drawing.ImageData.ToByteArray" />, <see cref="M:Aspose.Words.Drawing.ImageData.ToStream" />, <see cref="M:Aspose.Words.Drawing.ImageData.ToImage" /> or <see cref="M:Aspose.Words.Drawing.ImageData.Save(System.String)" /> methods.
- If the image is stored inside the shape, you can also directly access it using the <see cref="P:Aspose.Words.Drawing.ImageData.ImageBytes" /> property.</p>
- <p>To store an image inside a shape use the <see cref="M:Aspose.Words.Drawing.ImageData.SetImage(System.String)" /> method. To link an image to a shape, set the <see cref="P:Aspose.Words.Drawing.ImageData.SourceFullName" /> property.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.ImageData.SetImage(System.Drawing.Image)">
- <summary>
- Sets the image that the shape displays.
- </summary>
- <param name="image">The image object.</param>
- </member>
- <member name="M:Aspose.Words.Drawing.ImageData.SetImage(System.IO.Stream)">
- <summary>
- Sets the image that the shape displays.
- </summary>
- <param name="stream">The stream that contains the image.
- </param>
- </member>
- <member name="M:Aspose.Words.Drawing.ImageData.SetImage(System.String)">
- <summary>
- Sets the image that the shape displays.
- </summary>
- <param name="fileName">The image file. Can be a file name or a URL.</param>
- </member>
- <member name="M:Aspose.Words.Drawing.ImageData.ToImage">
- <summary>
- Gets the image stored in the shape as a <see cref="T:System.Drawing.Image" /> object.
- </summary>
- <returns>
- </returns>
- <remarks>
- <p>A new <see cref="T:System.Drawing.Image" /> object is created every time this method is called.</p>
- <p>It is the responsibility of the caller to dispose the image object.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.ImageData.ToStream">
- <summary>
- Creates and returns a stream that contains the image bytes.
- </summary>
- <remarks>
- <p>If the image bytes are stored in the shape, creates and returns a <see cref="T:System.IO.MemoryStream" /> object.</p>
- <p>If the image is linked and stored in a file, opens the file and returns a <see cref="T:System.IO.FileStream" /> object.</p>
- <p>If the image is linked and stored in an external URL, downloads the file and returns a <see cref="T:System.IO.MemoryStream" /> object.</p>
- <p>Is it the responsibility of the caller to dispose the stream object.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.ImageData.ToByteArray">
- <summary>
- Returns image bytes for any image regardless whether the image is stored or linked.
- </summary>
- <returns>
- </returns>
- <remarks>
- <para>If the image is linked, downloads the image every time it is called.</para>
- <seealso cref="P:Aspose.Words.Drawing.ImageData.ImageBytes" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.ImageData.Save(System.IO.Stream)">
- <summary>
- Saves the image into the specified stream.
- </summary>
- <param name="stream">The stream where to save the image to.</param>
- <overloads>Saves the image of the shape.</overloads>
- <remarks>
- <p>Is it the responsibility of the caller to dispose the stream object.</p>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.ImageData.Save(System.String)">
- <summary>
- Saves the image into a file.
- </summary>
- <param name="fileName">The file name where to save the image.</param>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.ImageBytes">
- <summary>
- Gets or sets the raw bytes of the image stored in the shape.
- </summary>
- <remarks>
- <para>Setting the value to <c>null</c> or an empty array will remove the image from the shape.</para>
- <p>Returns <c>null</c> if the image is not stored in the document (e.g the image is probably linked in this case).</p>
- <seealso cref="M:Aspose.Words.Drawing.ImageData.SetImage(System.String)" />
- <seealso cref="M:Aspose.Words.Drawing.ImageData.ToByteArray" />
- <seealso cref="M:Aspose.Words.Drawing.ImageData.ToImage" />
- <seealso cref="M:Aspose.Words.Drawing.ImageData.ToStream" />
- <seealso cref="M:Aspose.Words.Drawing.ImageData.Save(System.String)" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.HasImage">
- <summary>
- Returns true if the shape has image bytes or links an image.
- </summary>
- <value>
- </value>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.ImageSize">
- <summary>
- Gets the information about image size and resolution.
- </summary>
- <value>
- </value>
- <remarks>
- <p>If the image is linked only and not stored in the document, returns zero size.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.ImageType">
- <summary>
- Gets the type of the image.
- </summary>
- <value>
- </value>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.IsLink">
- <summary>
- Returns true if the image is linked to the shape (when <see cref="P:Aspose.Words.Drawing.ImageData.SourceFullName" /> is specified).
- </summary>
- <value>
- </value>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.IsLinkOnly">
- <summary>
- Returns true if the image is linked and not stored in the document.
- </summary>
- <value>
- </value>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.SourceFullName">
- <summary>
- Gets or sets the path and name of the source file for the linked image.
- </summary>
- <p>The default value is an empty string.</p>
- <p>If <see cref="P:Aspose.Words.Drawing.ImageData.SourceFullName" /> is not an empty string, the image is linked.</p>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.Title">
- <summary>
- Defines the title of an image.
- </summary>
- <remarks>
- <p>The default value is an empty string.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.CropTop">
- <summary>
- Defines the fraction of picture removal from the top side.
- </summary>
- <remarks>
- <p>The amount of cropping can range from -1.0 to 1.0. The default value is 0. Note
- that a value of 1 will display no picture at all. Negative values will result in
- the picture being squeezed inward from the edge being cropped (the empty space
- between the picture and the cropped edge will be filled by the fill color of the
- shape). Positive values less than 1 will result in the remaining picture being
- stretched to fit the shape.</p>
- <p>The default value is 0.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.CropBottom">
- <summary>
- Defines the fraction of picture removal from the bottom side.
- </summary>
- <remarks>
- <p>The amount of cropping can range from -1.0 to 1.0. The default value is 0. Note
- that a value of 1 will display no picture at all. Negative values will result in
- the picture being squeezed inward from the edge being cropped (the empty space
- between the picture and the cropped edge will be filled by the fill color of the
- shape). Positive values less than 1 will result in the remaining picture being
- stretched to fit the shape.</p>
- <p>The default value is 0.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.CropLeft">
- <summary>
- Defines the fraction of picture removal from the left side.
- </summary>
- <remarks>
- <p>The amount of cropping can range from -1.0 to 1.0. The default value is 0. Note
- that a value of 1 will display no picture at all. Negative values will result in
- the picture being squeezed inward from the edge being cropped (the empty space
- between the picture and the cropped edge will be filled by the fill color of the
- shape). Positive values less than 1 will result in the remaining picture being
- stretched to fit the shape.</p>
- <p>The default value is 0.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.CropRight">
- <summary>
- Defines the fraction of picture removal from the right side.
- </summary>
- <remarks>
- <p>The amount of cropping can range from -1.0 to 1.0. The default value is 0. Note
- that a value of 1 will display no picture at all. Negative values will result in
- the picture being squeezed inward from the edge being cropped (the empty space
- between the picture and the cropped edge will be filled by the fill color of the
- shape). Positive values less than 1 will result in the remaining picture being
- stretched to fit the shape.</p>
- <p>The default value is 0.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.Borders">
- <summary>
- Gets the collection of borders of the image. Borders only have effect for inline images.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.ChromaKey">
- <summary>
- Defines the color value of the image that will be treated as transparent.
- </summary>
- <remarks>
- <p>The default value is 0.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.Brightness">
- <summary>
- Gets or sets the brightness of the picture.
- The value for this property must be a number from 0.0 (dimmest) to 1.0 (brightest).
- </summary>
- <remarks>
- <p>The default value is 0.5.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.Contrast">
- <summary>
- Gets or sets the contrast for the specified picture. The value
- for this property must be a number from 0.0 (the least contrast) to 1.0 (the greatest contrast).
- </summary>
- <remarks>
- <p>The default value is 0.5.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.BiLevel">
- <summary>
- Determines whether an image will be displayed in black and white.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageData.GrayScale">
- <summary>
- Determines whether a picture will display in grayscale mode.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Drawing.ImageSize">
- <summary>
- Contains information about image size and resolution.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.ImageData.ImageSize" />
- </member>
- <member name="M:Aspose.Words.Drawing.ImageSize.#ctor(System.Int32,System.Int32)">
- <summary>
- Initializes width and height to the given values in pixels. Initializes resolution to 96 dpi.
- </summary>
- <param name="widthPixels">Width in pixels.</param>
- <param name="heightPixels">Height in pixels.</param>
- </member>
- <member name="M:Aspose.Words.Drawing.ImageSize.#ctor(System.Int32,System.Int32,System.Double,System.Double)">
- <summary>
- Initializes width, height and resolution to the given values.
- </summary>
- <param name="widthPixels">Width in pixels.</param>
- <param name="heightPixels">Height in pixels.</param>
- <param name="horizontalResolution">Horizontal resolution in DPI.</param>
- <param name="verticalResolution">Vertical resolution in DPI.</param>
- </member>
- <member name="M:Aspose.Words.Drawing.ImageSize.#ctor(Aspose.Images.ImageSizeCore)">
- <summary>
- Creates an object from an internal image size object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageSize.WidthPixels">
- <summary>
- Gets the width of the image in pixels.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageSize.HeightPixels">
- <summary>
- Gets the height of the image in pixels.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageSize.HorizontalResolution">
- <summary>
- Gets the horizontal resolution in DPI.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageSize.VerticalResolution">
- <summary>
- Gets the vertical resolution in DPI.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageSize.WidthPoints">
- <summary>
- Gets the width of the image in points. 1 point is 1/72 inch.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ImageSize.HeightPoints">
- <summary>
- Gets the height of the image in points. 1 point is 1/72 inch.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.ImageType">
- <summary>
- Specifies the type (format) of an image in a Microsoft Word document.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.ImageData.ImageType" />
- <dev>
- Do not renumber these. The values correspond to MSOBLIPTYPE in the Binary Drawing format.
- </dev>
- </member>
- <member name="F:Aspose.Words.Drawing.ImageType.NoImage">
- <summary>
- The is no image data.
- </summary>
- <dev>
- The spec says: "An error occurred during loading."
- I've seen this in some places, more likely it means "this blip record is unused".
- </dev>
- </member>
- <member name="F:Aspose.Words.Drawing.ImageType.Unknown">
- <summary>
- An unknown image type or image type that cannot be directly stored inside a Microsoft Word document.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ImageType.Emf">
- <summary>
- Windows Enhanced Metafile.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ImageType.Wmf">
- <summary>
- Windows Metafile.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ImageType.Pict">
- <summary>
- Macintosh PICT. An existing image will be preserved in a document, but inserting new
- PICT images into a document is not supported.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ImageType.Jpeg">
- <summary>
- JPEG JFIF.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ImageType.Png">
- <summary>
- Portable Network Graphics.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ImageType.Bmp">
- <summary>
- Windows Bitmap.
- </summary>
- <dev>
- Note this is BMP in my model, but in a Word document this is stored as a DIB.
- DIB is basically a BMP without a header.
- </dev>
- </member>
- <member name="T:Aspose.Words.Drawing.JoinStyle">
- <summary>
- Line join style.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.Stroke.JoinStyle" />
- </member>
- <member name="F:Aspose.Words.Drawing.JoinStyle.Bevel">
- <summary>
- Join edges by a straight line.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.JoinStyle.Miter">
- <summary>
- Extend edges until they join.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.JoinStyle.Round">
- <summary>
- Draw an arc between the two edges.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.LayoutFlow">
- <summary>
- Determines the flow of the text layout in a textbox.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.TextBox.LayoutFlow" />
- <dev>
- Do not renumber. The values are from the RTF spec.
- </dev>
- </member>
- <member name="F:Aspose.Words.Drawing.LayoutFlow.Horizontal">
- <summary>
- Text is displayed horizontally.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.LayoutFlow.TopToBottomIdeographic">
- <summary>
- Ideographic text is displayed vertically.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.LayoutFlow.BottomToTop">
- <summary>
- Text is displayed vertically.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.LayoutFlow.TopToBottom">
- <summary>
- Text is displayed vertically.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.LayoutFlow.HorizontalIdeographic">
- <summary>
- Ideographic text is displayed horizontally.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.LayoutFlow.Vertical">
- <summary>
- Text is displayed vertically.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.OleFormat">
- <summary>
- Provides access to the data of an OLE object or ActiveX control.
- </summary>
- <remarks>
- <p>Use the <see cref="P:Aspose.Words.Drawing.Shape.OleFormat" /> property to access the data of an OLE object.
- You do not create instances of the <see cref="T:Aspose.Words.Drawing.OleFormat" /> class directly.</p>
- <seealso cref="P:Aspose.Words.Drawing.Shape.OleFormat" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.OleFormat.Save(System.IO.Stream)">
- <summary>
- Saves the data of the embedded object into the specified stream.
- </summary>
- <remarks>
- <p>It is the responsibility of the caller to dispose the stream.</p>
- </remarks>
- <exception cref="T:System.InvalidOperationException">Throws if you attempt to save a linked object.</exception>
- <param name="stream">Where to save the object data.</param>
- </member>
- <member name="M:Aspose.Words.Drawing.OleFormat.Save(System.String)">
- <summary>
- Saves the data of the embedded object into a file with the specified name.
- </summary>
- <exception cref="T:System.InvalidOperationException">Throws if you attempt to save a linked object.</exception>
- <param name="fileName">Name of the file to save the OLE object data.</param>
- </member>
- <member name="M:Aspose.Words.Drawing.OleFormat.GetOleEntry(System.String)">
- <summary>
- Gets OLE object data entry.
- </summary>
- <param name="oleEntryName">Case-sensitive name of the OLE data stream.</param>
- <returns>An OLE data stream or null.</returns>
- </member>
- <member name="M:Aspose.Words.Drawing.OleFormat.GetRawData">
- <summary>
- Gets OLE object raw data.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.OleFormat.IconCaption">
- <summary>
- Gets icon caption of OLE object.
- <para>In case of OLE object is not embedded as icon or caption couldn't be retrieved returns empty string.</para></summary>
- </member>
- <member name="P:Aspose.Words.Drawing.OleFormat.SuggestedExtension">
- <summary>
- Gets the file extension suggested for the current embedded object if you want to save it into a file.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.OleFormat.SuggestedFileName">
- <summary>
- Gets the file name suggested for the current embedded object if you want to save it into a file.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.OleFormat.ProgId">
- <summary>
- Gets or sets the ProgID of the OLE object.
- </summary>
- <remarks>
- <para>The ProgID property is not always present in Microsoft Word documents and cannot be relied upon.</para>
- <para>Cannot be null.</para>
- <p>The default value is an empty string.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.OleFormat.IsLink">
- <summary>
- Returns true if the OLE object is linked (when <see cref="P:Aspose.Words.Drawing.OleFormat.SourceFullName" /> is specified).
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.OleFormat.SourceFullName">
- <summary>
- Gets or sets the path and name of the source file for the linked OLE object.
- </summary>
- <remarks>
- <p>The default value is an empty string.</p>
- <p>If <see cref="P:Aspose.Words.Drawing.OleFormat.SourceFullName" /> is not an empty string, the OLE object is linked.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.OleFormat.SourceItem">
- <summary>
- Gets or sets a string that is used to identify the portion of the source file that is being linked.
- </summary>
- <remarks>
- <p>The default value is an empty string.</p>
- <p>For example, if the source file is a Microsoft Excel workbook, the <see cref="P:Aspose.Words.Drawing.OleFormat.SourceItem" />
- property might return "Workbook1!R3C1:R4C2" if the OLE object contains only a few cells from
- the worksheet.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.OleFormat.AutoUpdate">
- <summary>
- Specifies whether the link to the OLE object is automatically updated or not in Microsoft Word.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.OleFormat.OleIcon">
- <summary>
- Gets the draw aspect of the OLE object. When <b>true</b>, the OLE object is displayed as an icon.
- When <b>false</b>, the OLE object is displayed as content.
- </summary>
- <remarks>
- <para>Aspose.Words does not allow to set this property to avoid confusion. If you were able to change
- the draw aspect in Aspose.Words, Microsoft Word would still display the OLE object in its original
- draw aspect until you edit or update the OLE object in Microsoft Word.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.OleFormat.IsLocked">
- <summary>
- Specifies whether the link to the OLE object is locked from updates.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.OleFormat.Clsid">
- <summary>
- Gets the CLSID of the OLE object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.OleFormat.OlePackage">
- <summary>
- Provide access to <see cref="T:Aspose.Words.Drawing.OlePackage" /> if OLE object is an OLE Package.
- Returns null otherwise.
- </summary>
- <remarks>
- OLE Package is a legacy technology that allows to wrap any file format not present in the OLE registry of
- a Windows system into a generic package allowing to embed almost anything into a document.
- See <see cref="T:Aspose.Words.Drawing.OlePackage" /> type for more info.
- </remarks>
- <dev>
- Has meaning only if ProgId equal to "Package" otherwise is null.
- </dev>
- </member>
- <member name="P:Aspose.Words.Drawing.OleFormat.OleControl">
- <summary>
- Gets <see cref="P:Aspose.Words.Drawing.OleFormat.OleControl" /> objects if this OLE object is an ActiveX control. Otherwise this property is null.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.RelativeHorizontalPosition">
- <summary>
- Specifies to what the horizontal position of a shape or text frame is relative.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.ShapeBase.RelativeHorizontalPosition" />
- <dev>
- Do not renumber. The values are taken from the RTF specification.
- </dev>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeHorizontalPosition.Margin">
- <summary>
- Specifies that the horizontal positioning shall be relative to the page margins.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeHorizontalPosition.Page">
- <summary>
- The object is positioned relative to the left edge of the page.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeHorizontalPosition.Column">
- <summary>
- The object is positioned relative to the left side of the column.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeHorizontalPosition.Character">
- <summary>
- The object is positioned relative to the left side of the paragraph.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeHorizontalPosition.LeftMargin">
- <summary>
- Specifies that the horizontal positioning shall be relative to the left margin of the page.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeHorizontalPosition.RightMargin">
- <summary>
- Specifies that the horizontal positioning shall be relative to the right margin of the page.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeHorizontalPosition.InsideMargin">
- <summary>
- Specifies that the horizontal positioning shall be relative to the inside margin of the
- current page (the left margin on odd pages, right on even pages).
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeHorizontalPosition.OutsideMargin">
- <summary>
- Specifies that the horizontal positioning shall be relative to the outside margin of the
- current page (the right margin on odd pages, left on even pages).
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeHorizontalPosition.Default">
- <summary>
- Default value is <see cref="F:Aspose.Words.Drawing.RelativeHorizontalPosition.Column" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.RelativeVerticalPosition">
- <summary>
- Specifies to what the vertical position of a shape or text frame is relative.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.ShapeBase.RelativeVerticalPosition" />
- <dev>
- Do not renumber. The values are taken from the RTF specification.
- </dev>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeVerticalPosition.Margin">
- <summary>
- Specifies that the vertical positioning shall be relative to the page margins.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeVerticalPosition.Page">
- <summary>
- The object is positioned relative to the top edge of the page.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeVerticalPosition.Paragraph">
- <summary>
- The object is positioned relative to the top of the paragraph that contains the anchor.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeVerticalPosition.Line">
- <summary>
- Undocumented.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeVerticalPosition.TopMargin">
- <summary>
- Specifies that the vertical positioning shall be relative to the top margin of the current page.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeVerticalPosition.BottomMargin">
- <summary>
- Specifies that the vertical positioning shall be relative to the bottom margin of the current page.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeVerticalPosition.InsideMargin">
- <summary>
- Specifies that the vertical positioning shall be relative to the inside margin of the current page.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeVerticalPosition.OutsideMargin">
- <summary>
- Specifies that the vertical positioning shall be relative to the outside margin of the current page.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeVerticalPosition.TableDefault">
- <summary>
- Default value is <see cref="F:Aspose.Words.Drawing.RelativeVerticalPosition.Margin" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.RelativeVerticalPosition.TextFrameDefault">
- <summary>
- Default value is <see cref="F:Aspose.Words.Drawing.RelativeVerticalPosition.Paragraph" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Shape">
- <summary>
- Represents an object in the drawing layer, such as an AutoShape, textbox, freeform, OLE object, ActiveX control, or picture.
- </summary>
- <remarks>
- <p>Using the <see cref="T:Aspose.Words.Drawing.Shape" /> class you can create or modify shapes in a Microsoft Word document.</p>
- <p>An important property of a shape is its <see cref="P:Aspose.Words.Drawing.ShapeBase.ShapeType" />. Shapes of different
- types can have different capabilities in a Word document. For example, only image and OLE shapes
- can have images inside them. Most of the shapes can have text, but not all.</p>
- <p>Shapes that can have text, can contain <see cref="T:Aspose.Words.Paragraph" /> and
- <see cref="T:Aspose.Words.Tables.Table" /> nodes as children.</p>
- <seealso cref="T:Aspose.Words.Drawing.ShapeBase" />
- <seealso cref="T:Aspose.Words.Drawing.GroupShape" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.Shape.#ctor(Aspose.Words.DocumentBase)">
- <summary>
- Ctor. Use this internally only.
- </summary>
- <param name="doc">The owner document.</param>
- </member>
- <member name="M:Aspose.Words.Drawing.Shape.#ctor(Aspose.Words.DocumentBase,Aspose.Words.Drawing.ShapeMarkupLanguage)">
- <summary>
- Ctor. Use this internally only.
- WORDSNET-11493 Implement possibility to create DML shapes by default.
- </summary>
- <param name="doc">The owner document.</param>
- <param name="markupLanguage">Shape markup language: DrawingML or Vml</param>
- </member>
- <member name="M:Aspose.Words.Drawing.Shape.#ctor(Aspose.Words.DocumentBase,Aspose.Words.Drawing.ShapeType)">
- <summary>
- Creates a new shape object.
- </summary>
- <remarks>
- <p>You should specify desired shape properties after you created a shape.</p>
- </remarks>
- <param name="doc">The owner document.</param>
- <param name="shapeType">The type of the shape to create.</param>
- </member>
- <member name="M:Aspose.Words.Drawing.Shape.Accept(Aspose.Words.DocumentVisitor)">
- <summary>
- Accepts a visitor.
- </summary>
- <remarks>
- <p>Enumerates over this node and all of its children. Each node calls a corresponding method on DocumentVisitor.</p>
- <p>For more info see the Visitor design pattern.</p>
- </remarks>
- <param name="visitor">The visitor that will visit the nodes.</param>
- <returns>True if all nodes were visited; false if DocumentVisitor stopped the operation before visiting all nodes.</returns>
- <remarks>
- Calls <see cref="M:Aspose.Words.DocumentVisitor.VisitShapeStart(Aspose.Words.Drawing.Shape)" />, then calls <see cref="M:Aspose.Words.Node.Accept(Aspose.Words.DocumentVisitor)" />
- for all child nodes of the shape and calls <see cref="M:Aspose.Words.DocumentVisitor.VisitShapeEnd(Aspose.Words.Drawing.Shape)" /> at the end.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.Shape.Clone(System.Boolean,Aspose.Words.INodeCloningListener)">
- <summary>
- Creates a duplicate of the node.
- </summary>
- <remarks>
- <p>This method serves as a copy constructor for nodes.
- The cloned node has no parent, but belongs to the same document as the original node.</p>
- <p>This method always performs a deep copy of the node. The <i>isCloneChildren</i> parameter
- specifies whether to perform copy all child nodes as well.</p>
- </remarks>
- <param name="isCloneChildren">True to recursively clone the subtree under the specified node;
- false to clone only the node itself.</param>
- <param name="cloningListener">Listener to node cloning event.</param>
- <returns>The cloned node.</returns>
- </member>
- <member name="M:Aspose.Words.Drawing.Shape.UpdateSmartArtDrawing">
- <summary>
- Updates SmartArt pre-rendered drawing by using Aspose.Words's SmartArt cold rendering engine.
- </summary>
- <remarks>
- Microsoft Word generates and saves the pre-rendered drawing along with SmartArt object. However,
- if the document is saved by other applications, the pre-rendered SmartArt drawing may be missing or incorrect.
- If pre-rendered drawing is available then Aspose.Words uses it to render the SmartArt object.
- If pre-rendered drawing is missing then Aspose.Words uses its own SmartArt cold rendering engine to render the
- SmartArt object.
- If pre-rendered drawing is incorrect then it is required to call this method to invoke the SmartArt cold
- rendering engine.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.NodeType">
- <summary>
- Returns <see cref="F:Aspose.Words.NodeType.Shape" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.StoryType">
- <summary>
- Returns <see cref="F:Aspose.Words.StoryType.Textbox" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.ExtrusionEnabled">
- <summary>
- Returns true if an extrusion effect is enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.ShadowEnabled">
- <summary>
- Returns true if a shadow effect is enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.Stroke">
- <summary>
- Defines a stroke for a shape.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.Stroked">
- <summary>
- Defines whether the path will be stroked.
- </summary>
- <remarks>
- <p>This is a shortcut to the <see cref="P:Aspose.Words.Drawing.Stroke.On" /> property.</p>
- <p>The default value is <b>true</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.StrokeWeight">
- <summary>
- Defines the brush thickness that strokes the path of a shape in points.
- </summary>
- <remarks>
- <p>This is a shortcut to the <see cref="P:Aspose.Words.Drawing.Stroke.Weight" /> property.</p>
- <p>The default value is 0.75.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.StrokeColor">
- <summary>
- Defines the color of a stroke.
- </summary>
- <remarks>
- <p>This is a shortcut to the <see cref="P:Aspose.Words.Drawing.Stroke.Color" /> property.</p>
- <p>The default value is
- <see cref="P:System.Drawing.Color.Black" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.Fill">
- <summary>
- Defines a fill for a shape.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.Filled">
- <summary>
- Determines whether the closed path of the shape will be filled.
- </summary>
- <remarks>
- <p>This is a shortcut to the <see cref="P:Aspose.Words.Drawing.Fill.On" /> property.</p>
- <p>The default value is <b>true</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.FillColor">
- <summary>
- Defines the brush color that fills the closed path of the shape.
- </summary>
- <remarks>
- <p>This is a shortcut to the <see cref="P:Aspose.Words.Drawing.Fill.Color" /> property.</p>
- <p>The default value is
- <see cref="P:System.Drawing.Color.White" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.HasImage">
- <summary>
- Returns true if the shape has image bytes or links an image.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.ImageData">
- <summary>
- Provides access to the image of the shape.
- Returns null if the shape cannot have an image.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.OleFormat">
- <summary>
- Provides access to the OLE data of a shape. For a shape that is not an OLE object or ActiveX control, returns null.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.TextBox">
- <summary>
- Defines attributes that specify how text is displayed in a shape.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.TextPath">
- <summary>
- Defines the text of the text path (of a WordArt object).
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.FirstParagraph">
- <summary>
- Gets the first paragraph in the shape.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.LastParagraph">
- <summary>
- Gets the last paragraph in the shape.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.HorizontalRuleFormat">
- <summary>
- Provides access to the properties of the horizontal rule shape.
- For a shape that is not a horizontal rule, returns null.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.SignatureLine">
- <summary>
- Gets <see cref="P:Aspose.Words.Drawing.Shape.SignatureLine" /> object if the shape is a signature line. Returns <b>null</b> otherwise.
- </summary>
- <remarks>You can insert new SignatureLines into the document using <see cref="M:Aspose.Words.DocumentBuilder.InsertSignatureLine(Aspose.Words.SignatureLineOptions)" /> and
- <seealso cref="M:Aspose.Words.DocumentBuilder.InsertSignatureLine(Aspose.Words.SignatureLineOptions,Aspose.Words.Drawing.RelativeHorizontalPosition,System.Double,Aspose.Words.Drawing.RelativeVerticalPosition,System.Double,Aspose.Words.Drawing.WrapType)" /></remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.HasChart">
- <summary>
- Returns true if this Shape has a <see cref="P:Aspose.Words.Drawing.Shape.Chart" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.HasSmartArt">
- <summary>
- Returns true if this Shape has a SmartArt object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Shape.Chart">
- <summary>
- Provides access to the chart properties if this shape has a Chart.
- </summary>
- <remarks>This property will return the <see cref="P:Aspose.Words.Drawing.Shape.Chart" /> object only if <see cref="P:Aspose.Words.Drawing.Shape.HasChart" />
- property is true for this Shape, and will throw an exception otherwise.</remarks>
- </member>
- <member name="T:Aspose.Words.Drawing.ShapeBase">
- <summary>
- Base class for objects in the drawing layer, such as an AutoShape, freeform, OLE object, ActiveX control, or picture.
- </summary>
- <remarks>
- <p>This is an abstract class. The two derived classes that you can instantiate
- are <see cref="T:Aspose.Words.Drawing.Shape" /> and <see cref="T:Aspose.Words.Drawing.GroupShape" />.</p>
- <p>A shape is a node in the document tree.</p>
- <p>If the shape is a child of a <see cref="T:Aspose.Words.Paragraph" /> object, then the shape is said to be "top-level".
- Top-level shapes are measured and positioned in points.</p>
- <p>A shape can also occur as a child of a <see cref="T:Aspose.Words.Drawing.GroupShape" /> object when several shapes
- are grouped. Child shapes of a group shape are positioned in the coordinate space and units
- defined by the <see cref="P:Aspose.Words.Drawing.ShapeBase.CoordSize" /> and <see cref="P:Aspose.Words.Drawing.ShapeBase.CoordOrigin" /> properties of the parent
- group shape.</p>
- <p>A shape can be positioned inline with text or floating. The positioning method is controlled
- using the <see cref="P:Aspose.Words.Drawing.ShapeBase.WrapType" /> property.</p>
- <p>When a shape is floating, it is positioned relative to something (e.g the current paragraph,
- the margin or the page). The relative positioning of the shape is specified using the
- <see cref="P:Aspose.Words.Drawing.ShapeBase.RelativeHorizontalPosition" /> and <see cref="P:Aspose.Words.Drawing.ShapeBase.RelativeVerticalPosition" /> properties.</p>
- <p>A floating shape be positioned explicitly using the <see cref="P:Aspose.Words.Drawing.ShapeBase.Left" /> and <see cref="P:Aspose.Words.Drawing.ShapeBase.Top" />
- properties or aligned relative to some other object using the <see cref="P:Aspose.Words.Drawing.ShapeBase.HorizontalAlignment" />
- and <see cref="P:Aspose.Words.Drawing.ShapeBase.VerticalAlignment" /> properties.</p>
- <seealso cref="T:Aspose.Words.Drawing.Shape" />
- <seealso cref="T:Aspose.Words.Drawing.GroupShape" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.ShapeBase.GetShapeRenderer">
- <summary>
- Creates and returns an object that can be used to render this shape into an image.
- </summary>
- <remarks>
- <para>This method just invokes the <see cref="T:Aspose.Words.Rendering.ShapeRenderer" /> constructor and passes
- this object as a parameter.</para>
- </remarks>
- <returns>The renderer object for this shape.</returns>
- </member>
- <member name="M:Aspose.Words.Drawing.ShapeBase.GetDirectShapeAttr(System.Int32)">
- <summary>
- Reserved for system use. IShapeAttrSource.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.ShapeBase.FetchInheritedShapeAttr(System.Int32)">
- <summary>
- Reserved for system use. IShapeAttrSource.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.ShapeBase.FetchShapeAttr(System.Int32)">
- <summary>
- Reserved for system use. IShapeAttrSource.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.ShapeBase.SetShapeAttr(System.Int32,System.Object)">
- <summary>
- Reserved for system use. IShapeAttrSource.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.ShapeBase.RemoveShapeAttr(System.Int32)">
- <summary>
- Reserved for system use. IShapeAttrSource.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.ShapeBase.LocalToParent(System.Drawing.PointF)">
- <summary>
- Converts a value from the local coordinate space into the coordinate space of the parent shape.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.ShapeBase.AdjustWithEffects(System.Drawing.RectangleF)">
- <summary>
- Adds to the source rectangle values of the effect extent and returns the final rectangle.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.ScreenTip">
- <summary>
- Defines the text displayed when the mouse pointer moves over the shape.
- </summary>
- <remarks>
- <p>The default value is an empty string.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.HRef">
- <summary>
- Gets or sets the full hyperlink address for a shape.
- </summary>
- <remarks>
- <p>The default value is an empty string.</p>
- <p>Below are examples of valid values for this property:</p>
- <p>Full URI: <c>https://www.aspose.com/</c>.</p>
- <p>Full file name: <c>C:\\My Documents\\SalesReport.doc</c>.</p>
- <para>Relative URI: <c>../../../resource.txt</c></para>
- <p>Relative file name: <c>..\\My Documents\\SalesReport.doc</c>.</p>
- <p>Bookmark within another document: <c>https://www.aspose.com/Products/Default.aspx#Suites</c></p>
- <p>Bookmark within this document: <c>#BookmakName</c>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.Target">
- <summary>
- Gets or sets the target frame for the shape hyperlink.
- </summary>
- <remarks>
- <p>The default value is an empty string.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.AlternativeText">
- <summary>
- Defines alternative text to be displayed instead of a graphic.
- </summary>
- <remarks>
- <p>The default value is an empty string.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.Title">
- <summary>
- Gets or sets the title (caption) of the current shape object.
- </summary>
- <remarks>
- <para>Default is empty string.</para>
- <para>Cannot be null, but can be an empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.Name">
- <summary>
- Gets or sets the optional shape name.
- </summary>
- <remarks>
- <para>Default is empty string.</para>
- <para>Cannot be null, but can be an empty string.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.IsInsertRevision">
- <summary>
- Returns true if this object was inserted in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.IsDeleteRevision">
- <summary>
- Returns true if this object was deleted in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.IsMoveFromRevision">
- <summary>
- Returns <b>true</b> if this object was moved (deleted) in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.IsMoveToRevision">
- <summary>
- Returns <b>true</b> if this object was moved (inserted) in Microsoft Word while change tracking was enabled.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.IsTopLevel">
- <summary>
- Returns true if this shape is not a child of a group shape.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.IsGroup">
- <summary>
- Returns true if this is a group shape.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.IsImage">
- <summary>
- Returns true if this shape is an image shape.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.IsHorizontalRule">
- <summary>
- Returns true if this shape is a horizontal rule.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.IsWordArt">
- <summary>
- Returns true if this shape is a WordArt object.
- </summary>
- <remarks>
- Works till 2007 compatibility mode.
- In 2010 and higher compatibility mode WordArt is just a TextBox with fancy fonts.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.CanHaveImage">
- <summary>
- Returns true if the shape type allows the shape to have an image.
- </summary>
- <remarks>
- <para>Although Microsoft Word has a special shape type for images, it appears that in Microsoft Word documents any shape
- except a group shape can have an image, therefore this property returns true for all shapes except <see cref="T:Aspose.Words.Drawing.GroupShape" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.AnchorLocked">
- <summary>
- Specifies whether the shape's anchor is locked.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- <p>Has effect only for top level shapes.</p>
- <p>This property affects behavior of the shape's anchor in Microsoft Word.
- When the anchor is not locked, moving the shape in Microsoft Word can move
- the shape's anchor too.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.AspectRatioLocked">
- <summary>
- Specifies whether the shape's aspect ratio is locked.
- </summary>
- <remarks>
- <p>The default value depends on the <see cref="P:Aspose.Words.Drawing.ShapeBase.ShapeType" />, for the ShapeType.Image it is <b>true</b>
- but for the other shape types it is <b>false</b>.</p>
- <p>Has effect for top level shapes only.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.AllowOverlap">
- <summary>
- Gets or sets a value that specifies whether this shape can overlap other shapes.
- </summary>
- <remarks>
- <para>This property affects behavior of the shape in Microsoft Word.
- Aspose.Words ignores the value of this property.</para>
- <para>This property is applicable only to top level shapes.</para>
- <p>The default value is <b>true</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.BehindText">
- <summary>
- Specifies whether the shape is below or above text.
- </summary>
- <remarks>
- <p>Has effect only for top level shapes.</p>
- <p>The default value is <b>false</b>.</p>
- <seealso cref="P:Aspose.Words.Drawing.ShapeBase.ZOrder" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.IsInline">
- <summary>
- A quick way to determine if this shape is positioned inline with text.
- </summary>
- <remarks>
- <p>Has effect only for top level shapes.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.Left">
- <summary>
- Gets or sets the position of the left edge of the containing block of the shape.
- </summary>
- <remarks>
- <p>For a top-level shape, the value is in points and relative to the shape anchor.</p>
- <p>For shapes in a group, the value is in the coordinate space and units of the parent group.</p>
- <p>The default value is 0.</p>
- <p>Has effect only for floating shapes.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.Top">
- <summary>
- Gets or sets the position of the top edge of the containing block of the shape.
- </summary>
- <remarks>
- <p>For a top-level shape, the value is in points and relative to the shape anchor.</p>
- <p>For shapes in a group, the value is in the coordinate space and units of the parent group.</p>
- <p>The default value is 0.</p>
- <p>Has effect only for floating shapes.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.Right">
- <summary>
- Gets the position of the right edge of the containing block of the shape.
- </summary>
- <remarks>
- <p>For a top-level shape, the value is in points and relative to the shape anchor.</p>
- <p>For shapes in a group, the value is in the coordinate space and units of the parent group.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.Bottom">
- <summary>
- Gets the position of the bottom edge of the containing block of the shape.
- </summary>
- <remarks>
- <p>For a top-level shape, the value is in points and relative to the shape anchor.</p>
- <p>For shapes in a group, the value is in the coordinate space and units of the parent group.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.Width">
- <summary>
- Gets or sets the width of the containing block of the shape.
- </summary>
- <remarks>
- <p>For a top-level shape, the value is in points.</p>
- <p>For shapes in a group, the value is in the coordinate space and units of the parent group.</p>
- <p>The default value is 0.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.Height">
- <summary>
- Gets or sets the height of the containing block of the shape.
- </summary>
- <remarks>
- <p>For a top-level shape, the value is in points.</p>
- <p>For shapes in a group, the value is in the coordinate space and units of the parent group.</p>
- <p>The default value is 0.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.DistanceTop">
- <summary>
- Returns or sets the distance (in points) between the document text and the top edge of the shape.
- </summary>
- <remarks>
- <p>The default value is 0.</p>
- <p>Has effect only for top level shapes.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.DistanceBottom">
- <summary>
- Returns or sets the distance (in points) between the document text and the bottom edge of the shape.
- </summary>
- <remarks>
- <p>The default value is 0.</p>
- <p>Has effect only for top level shapes.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.DistanceLeft">
- <summary>
- Returns or sets the distance (in points) between the document text and the left edge of the shape.
- </summary>
- <remarks>
- <p>The default value is 1/8 inch.</p>
- <p>Has effect only for top level shapes.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.DistanceRight">
- <summary>
- Returns or sets the distance (in points) between the document text and the right edge of the shape.
- </summary>
- <remarks>
- <p>The default value is 1/8 inch.</p>
- <p>Has effect only for top level shapes.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.Rotation">
- <summary>
- Defines the angle (in degrees) that a shape is rotated.
- Positive value corresponds to clockwise rotation angle.
- </summary>
- <remarks>
- <p>The default value is 0.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.ZOrder">
- <summary>
- Determines the display order of overlapping shapes.
- </summary>
- <remarks>
- <p>Has effect only for top level shapes.</p>
- <p>The default value is 0.</p>
- <p>The number represents the stacking precedence. A shape with a higher number will be displayed
- as if it were overlapping (in "front" of) a shape with a lower number. </p>
- <p>The order of overlapping shapes is independent for shapes in the header and in the main
- text of the document.</p>
- <p>The display order of child shapes in a group shape is determined by their order
- inside the group shape.</p>
- <seealso cref="P:Aspose.Words.Drawing.ShapeBase.BehindText" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.ParentParagraph">
- <summary>
- Returns the immediate parent paragraph.
- </summary>
- <remarks>For child shapes of a group shape and child shapes of an Office Math object always returns null.</remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.Bounds">
- <summary>
- Gets or sets the location and size of the containing block of the shape.
- </summary>
- <remarks>
- Ignores aspect ratio lock upon setting.
- </remarks>
- <remarks>
- <p>For a top-level shape, the value is in points and relative to the shape anchor.</p>
- <p>For shapes in a group, the value is in the coordinate space and units of the parent group.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.BoundsInPoints">
- <summary>
- Gets the location and size of the containing block of the shape in points, relative to the anchor of the topmost shape.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.BoundsWithEffects">
- <summary>
- Gets final extent that this shape object has after applying drawing effects.
- Value is measured in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.ShapeType">
- <summary>
- Gets the shape type.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.MarkupLanguage">
- <summary>
- Gets MarkupLanguage used for this graphic object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.SizeInPoints">
- <summary>
- Gets the size of the shape in points.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.FlipOrientation">
- <summary>
- Switches the orientation of a shape.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.FlipOrientation.None" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.RelativeHorizontalPosition">
- <summary>
- Specifies relative to what the shape is positioned horizontally.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.RelativeHorizontalPosition.Column" />.</p>
- <p>Has effect only for top level floating shapes.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.RelativeVerticalPosition">
- <summary>
- Specifies relative to what the shape is positioned vertically.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.RelativeVerticalPosition.Paragraph" />.</p>
- <p>Has effect only for top level floating shapes.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.HorizontalAlignment">
- <summary>
- Specifies how the shape is positioned horizontally.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.HorizontalAlignment.None" />.</p>
- <p>Has effect only for top level floating shapes.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.VerticalAlignment">
- <summary>
- Specifies how the shape is positioned vertically.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.VerticalAlignment.None" />.</p>
- <p>Has effect only for top level floating shapes.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.WrapType">
- <summary>
- Defines whether the shape is inline or floating. For floating shapes defines the wrapping mode for text around the shape.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.WrapType.None" />.</p>
- <p>Has effect only for top level shapes.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.WrapSide">
- <summary>
- Specifies how the text is wrapped around the shape.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.WrapSide.Both" />.</p>
- <p>Has effect only for top level shapes.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.CoordOrigin">
- <summary>
- The coordinates at the top-left corner of the containing block of this shape.
- </summary>
- <remarks>
- <p>The default value is (0,0).</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.CoordSize">
- <summary>
- The width and height of the coordinate space inside the containing block of this shape.
- </summary>
- <remarks>
- <p>The default value is (1000, 1000).</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.Font">
- <summary>
- Provides access to the font formatting of this object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.IsSignatureLine">
- <summary>
- Indicates that shape is a SignatureLine.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.ShapeBase.IsLayoutInCell">
- <summary>
- Gets or sets a flag indicating whether the shape is displayed inside a table or outside of it.
- </summary>
- <remarks>
- <p>The default value is <b>true</b>.</p>
- <p>Has effect only for top level shapes, the property <see cref="P:Aspose.Words.Drawing.ShapeBase.WrapType" /> of which is set to value
- other than <see cref="T:Aspose.Words.Inline" />.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Drawing.ShapeLineStyle">
- <summary>
- Specifies the compound line style of a <see cref="T:Aspose.Words.Drawing.Shape" />.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.Stroke.LineStyle" />
- <dev>
- This enum name violates the rule "enum name equals property name", but I have to avoid
- collision between Aspose.Words.LineStyle and this line style because otherwise it will
- be too hard to port to Java as all types are in the same namespace in Java.
- </dev>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeLineStyle.Single">
- <summary>
- Single line.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeLineStyle.Double">
- <summary>
- Double lines of equal width.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeLineStyle.ThickThin">
- <summary>
- Double lines, one thick, one thin.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeLineStyle.ThinThick">
- <summary>
- Double lines, one thin, one thick.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeLineStyle.Triple">
- <summary>
- Three lines, thin, thick, thin.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeLineStyle.Default">
- <summary>
- Default value is <see cref="F:Aspose.Words.Drawing.ShapeLineStyle.Single" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.ShapeType">
- <summary>
- Specifies the type of shape in a Microsoft Word document.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.ShapeBase.ShapeType" />
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Image">
- <summary>
- The shape is an image.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextBox">
- <summary>
- The shape is a textbox. Note that shapes of many other types can also have text inside them too.
- A shape does not have to have this type to contain text.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Group">
- <summary>
- <p>The shape is a group shape.</p>
- </summary>
- <dev>In DOC file, shape group has shape type NonPrimitive, we don't want this in the model,
- so in the model it is our own constant.</dev>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.OleObject">
- <summary>
- The shape is an OLE object.
- <p>You cannot create shapes of this type in the document.</p></summary>
- <dev>
- In Microsoft Word, shapes that represent OLE objects have shape type picture,
- but in our model, they are distinguished into their own shape type.
- </dev>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.OleControl">
- <summary>
- The shape is an ActiveX control.
- <p>You cannot create shapes of this type in the document.</p></summary>
- <dev>
- In DOC and RTF, shapes that represent ActiveX controls have shape type picture.
- In WordML, ActiveX controls have their own shape type and so is in the model.
- </dev>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.NonPrimitive">
- <summary>
- A shape drawn by user and consisting of multiple segments and/or vertices (curve, freeform or scribble).
- <p>You cannot create shapes of this type in the document.</p></summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Rectangle">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.RoundRectangle">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Ellipse">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Diamond">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Triangle">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.RightTriangle">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Parallelogram">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Trapezoid">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Hexagon">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Octagon">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Plus">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Star">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Arrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.ThickArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.HomePlate">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Cube">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Balloon">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Seal">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Arc">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Line">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Plaque">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Can">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Donut">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextSimple">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextOctagon">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextHexagon">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextCurve">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextWave">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextRing">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextOnCurve">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextOnRing">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.StraightConnector1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.BentConnector2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.BentConnector3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.BentConnector4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.BentConnector5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.CurvedConnector2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.CurvedConnector3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.CurvedConnector4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.CurvedConnector5">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Callout1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Callout2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Callout3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.AccentCallout1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.AccentCallout2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.AccentCallout3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.BorderCallout1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.BorderCallout2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.BorderCallout3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.AccentBorderCallout1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.AccentBorderCallout2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.AccentBorderCallout3">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Ribbon">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Ribbon2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Chevron">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Pentagon">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.NoSmoking">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Seal8">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Seal16">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Seal32">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.WedgeRectCallout">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.WedgeRRectCallout">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.WedgeEllipseCallout">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Wave">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FoldedCorner">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.LeftArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.DownArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.UpArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.LeftRightArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.UpDownArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.IrregularSeal1">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.IrregularSeal2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.LightningBolt">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Heart">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.QuadArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.LeftArrowCallout">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.RightArrowCallout">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.UpArrowCallout">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.DownArrowCallout">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.LeftRightArrowCallout">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.UpDownArrowCallout">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.QuadArrowCallout">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Bevel">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.LeftBracket">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.RightBracket">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.LeftBrace">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.RightBrace">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.LeftUpArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.BentUpArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.BentArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Seal24">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.StripedRightArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.NotchedRightArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.BlockArc">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.SmileyFace">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.VerticalScroll">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.HorizontalScroll">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.CircularArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.CustomShape">
- <summary>
- This shape type seems to be set for shapes that are not part of the standard set of the
- auto shapes in Microsoft Word. For example, if you insert a new auto shape from ClipArt.
- <p>You cannot create shapes of this type in the document.</p></summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.UturnArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.CurvedRightArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.CurvedLeftArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.CurvedUpArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.CurvedDownArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.CloudCallout">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.EllipseRibbon">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.EllipseRibbon2">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartProcess">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartDecision">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartInputOutput">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartPredefinedProcess">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartInternalStorage">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartDocument">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartMultidocument">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartTerminator">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartPreparation">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartManualInput">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartManualOperation">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartConnector">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartPunchedCard">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartPunchedTape">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartSummingJunction">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartOr">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartCollate">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartSort">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartExtract">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartMerge">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartOfflineStorage">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartOnlineStorage">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartMagneticTape">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartMagneticDisk">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartMagneticDrum">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartDisplay">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartDelay">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextPlainText">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextStop">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextTriangle">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextTriangleInverted">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextChevron">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextChevronInverted">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextRingInside">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextRingOutside">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextArchUpCurve">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextArchDownCurve">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextCircleCurve">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextButtonCurve">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextArchUpPour">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextArchDownPour">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextCirclePour">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextButtonPour">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextCurveUp">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextCurveDown">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextCascadeUp">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextCascadeDown">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextWave1">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextWave2">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextWave3">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextWave4">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextInflate">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextDeflate">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextInflateBottom">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextDeflateBottom">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextInflateTop">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextDeflateTop">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextDeflateInflate">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextDeflateInflateDeflate">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextFadeRight">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextFadeLeft">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextFadeUp">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextFadeDown">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextSlantUp">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextSlantDown">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextCanUp">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TextCanDown">
- <summary>
- WordArt object.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartAlternateProcess">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.FlowChartOffpageConnector">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Callout90">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.AccentCallout90">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.BorderCallout90">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.AccentBorderCallout90">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.LeftRightUpArrow">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Sun">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Moon">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.BracketPair">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.BracePair">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.Seal4">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.DoubleWave">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.ActionButtonBlank">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.ActionButtonHome">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.ActionButtonHelp">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.ActionButtonInformation">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.ActionButtonForwardNext">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.ActionButtonBackPrevious">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.ActionButtonEnd">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.ActionButtonBeginning">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.ActionButtonReturn">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.ActionButtonDocument">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.ActionButtonSound">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.ActionButtonMovie">
- <summary>
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.SingleCornerSnipped">
- <summary>
- Snip single corner rectangle object.
- </summary>
- <remarks>
- Applicable only for DML shapes.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TopCornersSnipped">
- <summary>
- Snip same side corner rectangle.
- </summary>
- <remarks>
- Applicable only for DML shapes.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.DiagonalCornersSnipped">
- <summary>
- Snip diagonal corner rectangle.
- </summary>
- <remarks>
- Applicable only for DML shapes.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TopCornersOneRoundedOneSnipped">
- <summary>
- Snip and round single corner rectangle.
- </summary>
- <remarks>
- Applicable only for DML shapes.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.SingleCornerRounded">
- <summary>
- Round single corner rectangle.
- </summary>
- <remarks>
- Applicable only for DML shapes.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.TopCornersRounded">
- <summary>
- Round same side corner rectangle.
- </summary>
- <remarks>
- Applicable only for DML shapes.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.DiagonalCornersRounded">
- <summary>
- Round diagonal corner rectangle.
- </summary>
- <remarks>
- Applicable only for DML shapes.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Drawing.ShapeType.MinValue">
- <summary>
- Reserved for the system use.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Stroke">
- <summary>
- Defines a stroke for a shape.
- </summary>
- <remarks>
- <p>Use the <see cref="P:Aspose.Words.Drawing.Shape.Stroke" /> property to access stroke properties of a shape.
- You do not create instances of the <see cref="T:Aspose.Words.Drawing.Stroke" /> class directly.</p>
- <seealso cref="P:Aspose.Words.Drawing.Shape.Stroke" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.On">
- <summary>
- Defines whether the path will be stroked.
- </summary>
- <remarks>
- <p>The default value is <b>true</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.Weight">
- <summary>
- Defines the brush thickness that strokes the path of a shape in points.
- </summary>
- <remarks>
- <p>The default value is 0.75.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.Color">
- <summary>
- Defines the color of a stroke.
- </summary>
- <remarks>
- <p>The default value is
- <see cref="P:System.Drawing.Color.Black" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.Color2">
- <summary>
- Defines a second color for a stroke.
- </summary>
- <remarks>
- <p>The default value is
- <see cref="P:System.Drawing.Color.White" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.DashStyle">
- <summary>
- Specifies the dot and dash pattern for a stroke.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.DashStyle.Solid" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.JoinStyle">
- <summary>
- Defines the join style of a polyline.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.JoinStyle.Round" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.EndCap">
- <summary>
- Defines the cap style for the end of a stroke.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.EndCap.Flat" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.LineStyle">
- <summary>
- Defines the line style of the stroke.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.ShapeLineStyle.Single" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.StartArrowType">
- <summary>
- Defines the arrowhead for the start of a stroke.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.ArrowType.None" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.EndArrowType">
- <summary>
- Defines the arrowhead for the end of a stroke.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.ArrowType.None" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.StartArrowWidth">
- <summary>
- Defines the arrowhead width for the start of a stroke.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.ArrowWidth.Medium" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.StartArrowLength">
- <summary>
- Defines the arrowhead length for the start of a stroke.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.ArrowLength.Medium" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.EndArrowWidth">
- <summary>
- Defines the arrowhead width for the end of a stroke.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.ArrowWidth.Medium" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.EndArrowLength">
- <summary>
- Defines the arrowhead length for the end of a stroke.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.ArrowLength.Medium" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.Opacity">
- <summary>
- Defines the amount of transparency of a stroke. Valid range is from 0 to 1.
- </summary>
- <remarks>
- <p>The default value is 1.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Stroke.ImageBytes">
- <summary>
- Defines the image for a stroke image or pattern fill.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.TextBox">
- <summary>
- Defines attributes that specify how a text is displayed inside a shape.
- </summary>
- <remarks>
- <p>Use the <see cref="P:Aspose.Words.Drawing.Shape.TextBox" /> property to access text properties of a shape.
- You do not create instances of the <see cref="T:Aspose.Words.Drawing.TextBox" /> class directly.</p>
- <seealso cref="P:Aspose.Words.Drawing.Shape.TextBox" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.TextBox.IsValidLinkTarget(Aspose.Words.Drawing.TextBox)">
- <summary>
- Determines whether this TextBox can be linked to the target Textbox.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.TextBox.BreakForwardLink">
- <summary>
- Breaks the link to the next TextBox.
- </summary>
- <remarks>
- BreakForwardLink() doesn't break all other links in the current sequence of shapes.
- For example: 1-2-3-4 sequence and BreakForwardLink at the 2-nd textbox will create
- two sequences 1-2, 3-4.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextBox.InternalMarginLeft">
- <summary>
- Specifies the inner left margin in points for a shape.
- </summary>
- <remarks>
- <p>The default value is 1/10 inch.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextBox.InternalMarginRight">
- <summary>
- Specifies the inner right margin in points for a shape.
- </summary>
- <remarks>
- <p>The default value is 1/10 inch.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextBox.InternalMarginTop">
- <summary>
- Specifies the inner top margin in points for a shape.
- </summary>
- <remarks>
- <p>The default value is 1/20 inch.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextBox.InternalMarginBottom">
- <summary>
- Specifies the inner bottom margin in points for a shape.
- </summary>
- <remarks>
- <p>The default value is 1/20 inch.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextBox.FitShapeToText">
- <summary>
- Determines whether Microsoft Word will grow the shape to fit text.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextBox.LayoutFlow">
- <summary>
- Determines the flow of the text layout in a shape.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.LayoutFlow.Horizontal" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextBox.TextBoxWrapMode">
- <summary>
- Determines how text wraps inside a shape.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.TextBoxWrapMode.Square" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextBox.VerticalAnchor">
- <summary>
- Specifies the vertical alignment of the text within a shape.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.TextBoxAnchor.Top" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextBox.Next">
- <summary>
- Returns or sets a TextBox that represents the next TextBox in a sequence of shapes.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.TextBox.Previous">
- <summary>
- Returns a TextBox that represents the previous TextBox in a sequence of shapes.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.TextBox.Parent">
- <summary>
- Gets a parent shape for the TextBox.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.TextBoxAnchor">
- <summary>
- Specifies values used for shape text vertical alignment.
- </summary>
- <dev>
- Do not renumber. The values are from the RTF spec.
- </dev>
- </member>
- <member name="F:Aspose.Words.Drawing.TextBoxAnchor.Top">
- <summary>
- Text is aligned to the top of the textbox.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextBoxAnchor.Middle">
- <summary>
- Text is aligned to the middle of the textbox.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextBoxAnchor.Bottom">
- <summary>
- Text is aligned to the bottom of the textbox.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextBoxAnchor.TopCentered">
- <summary>
- Text is aligned to the top centered of the textbox.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextBoxAnchor.MiddleCentered">
- <summary>
- Text is aligned to the middle centered of the textbox.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextBoxAnchor.BottomCentered">
- <summary>
- Text is aligned to the bottom centered of the textbox.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextBoxAnchor.TopBaseline">
- <summary>
- Text is aligned to the top baseline of the textbox.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextBoxAnchor.BottomBaseline">
- <summary>
- Text is aligned to the bottom baseline of the textbox.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextBoxAnchor.TopCenteredBaseline">
- <summary>
- Text is aligned to the top centered baseline of the textbox.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextBoxAnchor.BottomCenteredBaseline">
- <summary>
- Text is aligned to the bottom centered baseline of the textbox.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.TextBoxWrapMode">
- <summary>
- Specifies how text wraps inside a shape.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextBoxWrapMode.Square">
- <summary>
- Text wraps inside a shape.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextBoxWrapMode.None">
- <summary>
- Text does not wrap inside a shape.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.TextPath">
- <summary>
- Defines the text and formatting of the text path (of a WordArt object).
- </summary>
- <remarks>
- <p>Use the <see cref="P:Aspose.Words.Drawing.Shape.TextPath" /> property to access WordArt properties of a shape.
- You do not create instances of the <see cref="T:Aspose.Words.Drawing.TextPath" /> class directly.</p>
- <seealso cref="P:Aspose.Words.Drawing.Shape.TextPath" />
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.On">
- <summary>
- Defines whether the text is displayed.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.FitPath">
- <summary>
- Defines whether the text fits the path of a shape.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.FitShape">
- <summary>
- Defines whether the text fits bounding box of a shape.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.FontFamily">
- <summary>
- Defines the family of the textpath font.
- </summary>
- <remarks>
- <p>The default value is Arial.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.Size">
- <summary>
- Defines the size of the font in points.
- </summary>
- <remarks>
- <p>The default value is 36.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.Bold">
- <summary>
- True if the font is formatted as bold.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.Italic">
- <summary>
- True if the font is formatted as italic.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.SmallCaps">
- <summary>
- True if the font is formatted as small capital letters.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.RotateLetters">
- <summary>
- Determines whether the letters of the text are rotated.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.Trim">
- <summary>
- Determines whether extra space is removed above and below the text.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.Kerning">
- <summary>
- Determines whether kerning is turned on.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.Shadow">
- <summary>
- Defines whether a shadow is applied to the text on a text path.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.Underline">
- <summary>
- True if the font is underlined.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.StrikeThrough">
- <summary>
- True if the font is formatted as strikethrough text.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.SameLetterHeights">
- <summary>
- Determines whether all letters will be the same height regardless of initial case.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.Text">
- <summary>
- Defines the text of the text path.
- </summary>
- <remarks>
- <p>The default value is an empty string.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.TextPathAlignment">
- <summary>
- Defines the alignment of text.
- </summary>
- <remarks>
- <p>The default value is <see cref="F:Aspose.Words.Drawing.TextPathAlignment.Center" />.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.ReverseRows">
- <summary>
- Determines whether the layout order of rows is reversed.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- <p>If <b>true</b>, the layout order of rows is reversed. This attribute is used for vertical text layout.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.Spacing">
- <summary>
- Defines the amount of spacing for text. 1 means 100%.
- </summary>
- <remarks>
- <p>The default value is 1.</p>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.TextPath.XScale">
- <summary>
- Determines whether a straight textpath will be used instead of the shape path.
- </summary>
- <remarks>
- <p>The default value is <b>false</b>.</p>
- <p>If <b>true</b>, the text runs along a path from left to right along the x value of
- the lower boundary of the shape.</p>
- </remarks>
- </member>
- <member name="T:Aspose.Words.Drawing.TextPathAlignment">
- <summary>
- WordArt alignment.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.TextPath.TextPathAlignment" />
- </member>
- <member name="F:Aspose.Words.Drawing.TextPathAlignment.Stretch">
- <summary>
- Stretch each line of text to fit width.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextPathAlignment.Center">
- <summary>
- Center text on width.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextPathAlignment.Left">
- <summary>
- Left justify.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextPathAlignment.Right">
- <summary>
- Right justify.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextPathAlignment.LetterJustify">
- <summary>
- Spread letters out to fit width.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.TextPathAlignment.WordJustify">
- <summary>
- Spread words out to fit width.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.VerticalAlignment">
- <summary>
- Specifies vertical alignment of a floating shape, text frame or a floating table.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.ShapeBase.VerticalAlignment" />
- <dev>
- Do not renumber. The values are taken from the RTF specification.
- </dev>
- </member>
- <member name="F:Aspose.Words.Drawing.VerticalAlignment.None">
- <summary>
- The object is explicitly positioned, usually using its <b>Top</b> property.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.VerticalAlignment.Top">
- <summary>
- Specifies that the object shall be at the top of the vertical alignment base.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.VerticalAlignment.Center">
- <summary>
- Specifies that the object shall be centered with respect to the vertical alignment base.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.VerticalAlignment.Bottom">
- <summary>
- Specifies that the object shall be at the bottom of the vertical alignment base.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.VerticalAlignment.Inside">
- <summary>
- Specifies that the object shall be inside of the horizontal alignment base.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.VerticalAlignment.Outside">
- <summary>
- Specifies that the object shall be outside of the vertical alignment base.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.VerticalAlignment.Inline">
- <summary>
- Not documented. Seems to be a possible value for floating paragraphs and tables.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.VerticalAlignment.Default">
- <summary>
- Same as <see cref="F:Aspose.Words.Drawing.VerticalAlignment.None" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.WrapSide">
- <summary>
- Specifies what side(s) of the shape or picture the text wraps around.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.ShapeBase.WrapSide" />
- </member>
- <member name="F:Aspose.Words.Drawing.WrapSide.Both">
- <summary>
- The document text wraps on both sides of the shape.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.WrapSide.Left">
- <summary>
- The document text wraps on the left side of the shape only. There is a text free area on the right of the shape.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.WrapSide.Right">
- <summary>
- The document text wraps on the right side of the shape only. There is a text free area on the left side of the shape.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.WrapSide.Largest">
- <summary>
- The document text wraps on the side of the shape that is farthest from the page margin, leaving text free area on the other side of the shape.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.WrapSide.Default">
- <summary>
- Default value is <see cref="F:Aspose.Words.Drawing.WrapSide.Both" />.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.WrapType">
- <summary>
- Specifies how text is wrapped around a shape or picture.
- </summary>
- <seealso cref="P:Aspose.Words.Drawing.ShapeBase.WrapType" />
- </member>
- <member name="F:Aspose.Words.Drawing.WrapType.None">
- <summary>
- No text wrapping around the shape. The shape is placed behind or in front of text.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.WrapType.Inline">
- <summary>
- The shape remains on the same layer as text and treated as a character.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.WrapType.TopBottom">
- <summary>
- The text stops at the top of the shape and restarts on the line below the shape.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.WrapType.Square">
- <summary>
- Wraps text around all sides of the square bounding box of the shape.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.WrapType.Tight">
- <summary>
- Wraps tightly around the edges of the shape, instead of wrapping around the bounding box.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.WrapType.Through">
- <summary>
- Same as Tight, but wraps inside any parts of the shape that are open.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Ole.NamespaceDoc">
- <summary>
- <para>Contains classes to work with OLE / ActiveX controls and forms in Microsoft Word documents.</para>
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Ole.OleControl">
- <summary>
- Represents OLE ActiveX control.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Ole.OleControl.IsForms2OleControl">
- <summary>
- Returns true if the control is a <see cref="T:Aspose.Words.Drawing.Ole.Forms2OleControl" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Ole.OleControl.Name">
- <summary>
- Gets name of the ActiveX control.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Ole.Forms2OleControlCollection">
- <summary>
- Represents collection of <see cref="T:Aspose.Words.Drawing.Ole.Forms2OleControl" /> objects.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Ole.Forms2OleControlCollection.Item(System.Int32)">
- <summary>
- Gets <see cref="T:Aspose.Words.Drawing.Ole.Forms2OleControl" /> object at specified index.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Ole.Forms2OleControlCollection.Count">
- <summary>
- Gets count of objects in the collection.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Ole.Forms2OleControl">
- <summary>
- Represents Microsoft Forms 2.0 OLE control.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Ole.Forms2OleControl.Caption">
- <summary>
- Gets Caption property of control. Default value is an empty string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Ole.Forms2OleControl.Value">
- <summary>
- Gets underlying Value property which often represents control state.
- For example checked option button has '1' value while unchecked has '0'.
- Default value is an empty string.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Ole.Forms2OleControl.Enabled">
- <summary>
- Returns true if control is in enabled state.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Ole.Forms2OleControl.ChildNodes">
- <summary>
- Gets collection of immediate child controls.
- </summary>
- <remarks>Returns <b>null</b> if this control can not have children.</remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Ole.Forms2OleControl.Type">
- <summary>
- Gets type of Forms 2.0 control.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Core.NamespaceDoc">
- <summary>
- <p>The <b>Aspose.Words.Drawing</b> namespace contains classes that allow to
- create and modify drawing objects in Microsoft Word documents.</p>
- <p>Aspose.Words supports all drawing objects in Microsoft Word documents, including
- OfficeArt shapes, textboxes, pictures, diagrams, OLE objects and ActiveX controls.</p>
- <p>The main classes in this namespace are:</p>
- <list type="bullet">
- <item>
- <see cref="T:Aspose.Words.Drawing.Shape" /> represents an object in the drawing layer,
- such as an AutoShape, textbox, freeform, OLE object, ActiveX control, or picture.</item>
- <item>
- <see cref="T:Aspose.Words.Drawing.GroupShape" /> represents a group of shapes
- in a document.</item>
- <item>
- <see cref="T:Aspose.Words.Drawing.ShapeBase" /> is the base class for the
- shape and group shape classes, provides all common shape properties such as position,
- size and text wrapping. A shape is a node in the document tree.</item>
- </list>
- <p>Although not every type of drawing object can be programmatically created and not every shape
- property can be accessed, all drawing objects are fully preserved in Microsoft Word documents
- during document open-save operations.</p>
- <p>Names of classes, methods and properties in this namespace correspond to VML DOM where possible.</p>
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.AxisBound">
- <summary>
- Represents minimum or maximum bound of axis values.
- </summary>
- <remarks>
- <para>Bound can be specified as a numeric, datetime or a special "auto" value.</para>
- <para>The instances of this class are immutable.</para>
- <seealso cref="P:Aspose.Words.Drawing.Charts.AxisScaling.Minimum" />
- <seealso cref="P:Aspose.Words.Drawing.Charts.AxisScaling.Maximum" />
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.AxisBound.#ctor">
- <summary>
- Creates a new instance indicating that axis bound should be determined automatically by a word-processing
- application.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.AxisBound.#ctor(System.Double)">
- <summary>
- Creates an axis bound represented as a number.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.AxisBound.#ctor(System.DateTime)">
- <summary>
- Creates an axis bound represented as datetime value.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.AxisBound.Equals(System.Object)">
- <summary>
- Determines whether the specified object is equal in value to the current object.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.AxisBound.GetHashCode">
- <summary>
- Serves as a hash function for this type.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.AxisBound.ToString">
- <summary>
- Returns a user-friendly string that displays the value of this object.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.AxisBound.IsAuto">
- <summary>
- Returns a flag indicating that axis bound should be determined automatically.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.AxisBound.Value">
- <summary>
- Returns numeric value of axis bound.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.AxisBound.ValueAsDate">
- <summary>
- Returns value of axis bound represented as datetime.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.AxisCategoryType">
- <summary>
- Specifies type of a category axis.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisCategoryType.Automatic">
- <summary>
- Specifies that type of a category axis is determined automatically based on data.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisCategoryType.Category">
- <summary>
- Specifies an axis of an arbitrary set of categories.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisCategoryType.Time">
- <summary>
- Specifies a time category axis.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.AxisScaleType">
- <summary>
- Specifies the possible scale types for an axis.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisScaleType.Linear">
- <summary>
- Linear scaling.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisScaleType.Logarithmic">
- <summary>
- Logarithmic scaling.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.ChartNumberFormat">
- <summary>
- Represents number formatting of the parent element.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartNumberFormat.FormatCode">
- <summary>
- Gets or sets the format code applied to a data label.
- </summary>
- <remarks>
- Number formatting is used to change the way a value appears in data label and can be used in some very creative ways.
- The examples of number formats:
- <para>Number - "#,##0.00"</para><para>Currency - "\"$\"#,##0.00"</para><para>Time - "[$-x-systime]h:mm:ss AM/PM"</para><para>Date - "d/mm/yyyy"</para><para>Percentage - "0.00%"</para><para>Fraction - "# ?/?"</para><para>Scientific - "0.00E+00"</para><para>Text - "@"</para><para>Accounting - "_-\"$\"* #,##0.00_-;-\"$\"* #,##0.00_-;_-\"$\"* \"-\"??_-;_-@_-"</para><para>Custom with color - "[Red]-#,##0.0"</para></remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartNumberFormat.IsLinkedToSource">
- <summary>
- Specifies whether the format code is linked to a source cell.
- Default is true.
- </summary>
- <remarks>The NumberFormat will be reset to general if format code is linked to source.</remarks>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.Chart">
- <summary>
- Provides access to the chart shape properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.Chart.Series">
- <summary>
- Provides access to series collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.Chart.Title">
- <summary>
- Provides access to the chart title properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.Chart.Legend">
- <summary>
- Provides access to the chart legend properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.Chart.AxisX">
- <summary>
- Provides access to properties of the X axis of the chart.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.Chart.AxisY">
- <summary>
- Provides access to properties of the Y axis of the chart.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.Chart.AxisZ">
- <summary>
- Provides access to properties of the Z axis of the chart.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.ChartType">
- <summary>
- Specifies type of a chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Area">
- <summary>
- Area chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.AreaStacked">
- <summary>
- Stacked Area chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.AreaPercentStacked">
- <summary>
- 100% Stacked Area chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Area3D">
- <summary>
- 3D Area chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Area3DStacked">
- <summary>
- 3D Stacked Area chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Area3DPercentStacked">
- <summary>
- 3D 100% Stacked Area chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Bar">
- <summary>
- Bar chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.BarStacked">
- <summary>
- Stacked Bar chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.BarPercentStacked">
- <summary>
- 100% Stacked Bar chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Bar3D">
- <summary>
- 3D Bar chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Bar3DStacked">
- <summary>
- 3D Stacked Bar chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Bar3DPercentStacked">
- <summary>
- 3D 100% Stacked Bar chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Bubble">
- <summary>
- Bubble chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Bubble3D">
- <summary>
- 3D Bubble chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Column">
- <summary>
- Column chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.ColumnStacked">
- <summary>
- Stacked Column chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.ColumnPercentStacked">
- <summary>
- 100% Stacked Column chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Column3D">
- <summary>
- 3D Column chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Column3DStacked">
- <summary>
- 3D Stacked Column chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Column3DPercentStacked">
- <summary>
- 3D 100% Stacked Column chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Column3DClustered">
- <summary>
- 3D Clustered Column chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Doughnut">
- <summary>
- Doughnut chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Line">
- <summary>
- Line chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.LineStacked">
- <summary>
- Stacked Line chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.LinePercentStacked">
- <summary>
- 100% Stacked Line chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Line3D">
- <summary>
- 3D Line chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Pie">
- <summary>
- Pie chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Pie3D">
- <summary>
- 3D Pie chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.PieOfBar">
- <summary>
- Pie of Bar chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.PieOfPie">
- <summary>
- Pie of Pie chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Radar">
- <summary>
- Radar chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Scatter">
- <summary>
- Scatter chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Stock">
- <summary>
- Stock chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Surface">
- <summary>
- Surface chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartType.Surface3D">
- <summary>
- 3D Surface chart.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.IChartDataPoint">
- <summary>
- Contains properties of a single data point on the chart.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.IChartDataPoint.Explosion">
- <summary>
- Specifies the amount the data point shall be moved from the center of the pie.
- Can be negative, negative means that property is not set and no explosion should be applied.
- Applies only to Pie charts.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.IChartDataPoint.InvertIfNegative">
- <summary>
- Specifies whether the parent element shall inverts its colors if the value is negative.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.IChartDataPoint.Marker">
- <summary>
- Specifies a data marker. Marker is automatically created when requested.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.IChartDataPoint.Bubble3D">
- <summary>
- Specifies whether the bubbles in Bubble chart should have a 3-D effect applied to them.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.NamespaceDoc">
- <summary>
- <para>The <b>Aspose.Words.Drawing.Charts</b> namespace provides classes that allow to access charts in Microsoft Word documents.</para>
- <para>The chart supported are Word 2007 (or higher) DrawingML Charts.</para>
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.ChartSeriesCollection">
- <summary>
- Represents collection of a <see cref="T:Aspose.Words.Drawing.Charts.ChartSeries" />.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartSeriesCollection.GetEnumerator">
- <summary>
- Returns an enumerator object.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartSeriesCollection.RemoveAt(System.Int32)">
- <summary>
- Removes a <see cref="T:Aspose.Words.Drawing.Charts.ChartSeries" /> at the specified index.
- </summary>
- <param name="index">The zero-based index of the ChartSeries to remove.</param>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartSeriesCollection.Clear">
- <summary>
- Removes all <see cref="T:Aspose.Words.Drawing.Charts.ChartSeries" /> from this collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartSeriesCollection.Add(System.String,System.String[],System.Double[])">
- <summary>
- Adds new <see cref="T:Aspose.Words.Drawing.Charts.ChartSeries" /> to this collection.
- Use this method to add series to any type of Bar, Column, Line and Surface charts.
- </summary>
- <returns>Recently added <see cref="T:Aspose.Words.Drawing.Charts.ChartSeries" /> object.</returns>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartSeriesCollection.Add(System.String,System.Double[],System.Double[])">
- <summary>
- Adds new <see cref="T:Aspose.Words.Drawing.Charts.ChartSeries" /> to this collection.
- Use this method to add series to any type of Scatter charts.
- </summary>
- <returns>Recently added <see cref="T:Aspose.Words.Drawing.Charts.ChartSeries" /> object.</returns>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartSeriesCollection.Add(System.String,System.DateTime[],System.Double[])">
- <summary>
- Adds new <see cref="T:Aspose.Words.Drawing.Charts.ChartSeries" /> to this collection.
- Use this method to add series to any type of Area, Radar and Stock charts.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartSeriesCollection.Add(System.String,System.Double[],System.Double[],System.Double[])">
- <summary>
- Adds new <see cref="T:Aspose.Words.Drawing.Charts.ChartSeries" /> to this collection.
- Use this method to add series to any type of Bubble charts.
- </summary>
- <returns>Recently added <see cref="T:Aspose.Words.Drawing.Charts.ChartSeries" /> object.</returns>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartSeriesCollection.Item(System.Int32)">
- <summary>
- Returns a <see cref="T:Aspose.Words.Drawing.Charts.ChartSeries" /> at the specified index.
- </summary>
- <remarks>
- <p>The index is zero-based.</p>
- <p>Negative indexes are allowed and indicate access from the back of the collection.
- For example -1 means the last item, -2 means the second before last and so on.</p>
- <p>If index is greater than or equal to the number of items in the list, this returns a null reference.</p>
- <p>If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.</p>
- </remarks>
- <param name="index">An index into the collection.</param>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartSeriesCollection.Count">
- <summary>
- Returns the number of <see cref="T:Aspose.Words.Drawing.Charts.ChartSeries" /> in this collection.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.ChartDataLabel">
- <summary>
- Represents data label on a chart point or trendline.
- </summary>
- <remarks>
- On a series, the <see cref="T:Aspose.Words.Drawing.Charts.ChartDataLabel" /> object is a member of the <see cref="T:Aspose.Words.Drawing.Charts.ChartDataLabelCollection" />.
- The <see cref="T:Aspose.Words.Drawing.Charts.ChartDataLabelCollection" /> contains a <see cref="T:Aspose.Words.Drawing.Charts.ChartDataLabel" /> object for each point.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartDataLabel.ClearFormat">
- <summary>
- Clears format of this data label. The properties are set to the default values defined in the parent data
- label collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabel.Index">
- <summary>
- Specifies the index of the containing element.
- This index shall determine which of the parent's children collection this element applies to.
- Default value is 0.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowCategoryName">
- <summary>
- Allows to specify if category name is to be displayed for the data labels on a chart.
- Default value is false.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowBubbleSize">
- <summary>
- Allows to specify if bubble size is to be displayed for the data labels on a chart.
- Applies only to Bubble charts.
- Default value is false.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowLegendKey">
- <summary>
- Allows to specify if legend key is to be displayed for the data labels on a chart.
- Default value is false.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowPercentage">
- <summary>
- Allows to specify if percentage value is to be displayed for the data labels on a chart.
- Default value is false.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowSeriesName">
- <summary>
- Returns or sets a Boolean to indicate the series name display behavior for the data labels on a chart.
- True to show the series name. False to hide. By default false.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowValue">
- <summary>
- Allows to specify if values are to be displayed in the data labels.
- Default value is false.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowLeaderLines">
- <summary>
- Allows to specify if data label leader lines need be shown.
- Default value is false.
- </summary>
- <remarks>
- Applies to Pie charts only.
- Leader lines create a visual connection between a data label and its corresponding data point.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowDataLabelsRange">
- <summary>
- Allows to specify if values from data labels range to be displayed in the data labels.
- Default value is false.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabel.Separator">
- <summary>
- Gets or sets string separator used for the data labels on a chart.
- The default is a comma, except for pie charts showing only category name and percentage, when a line break
- shall be used instead.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabel.IsVisible">
- <summary>
- Returns true if this data label has something to display.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabel.NumberFormat">
- <summary>
- Returns number format of the parent element.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabel.IsHidden">
- <summary>
- Gets/sets a flag indicating whether this label is hidden.
- The default value is <b>false</b>.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.ChartDataLabelCollection">
- <summary>
- Represents a collection of <see cref="T:Aspose.Words.Drawing.Charts.ChartDataLabel" />.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.GetEnumerator">
- <summary>
- Returns an enumerator object.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.Add(System.Int32)">
- <summary>
- Adds new <see cref="T:Aspose.Words.Drawing.Charts.ChartDataLabel" /> at the specified index.
- </summary>
- <param name="index">Target data label index.</param>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.RemoveAt(System.Int32)">
- <summary>
- Clears format of a <see cref="T:Aspose.Words.Drawing.Charts.ChartDataLabel" /> at the specified index.
- </summary>
- <param name="index">The zero-based index of the chart data label to clear format.</param>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.Clear">
- <summary>
- Clears format of all <see cref="T:Aspose.Words.Drawing.Charts.ChartDataLabel" /> in this collection.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.ClearFormat">
- <summary>
- Clears format of all <see cref="T:Aspose.Words.Drawing.Charts.ChartDataLabel" /> in this collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.Item(System.Int32)">
- <summary>
- Returns <see cref="T:Aspose.Words.Drawing.Charts.ChartDataLabel" /> for the specified index.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.Count">
- <summary>
- Returns the number of <see cref="T:Aspose.Words.Drawing.Charts.ChartDataLabel" /> in this collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.ShowCategoryName">
- <summary>
- Allows to specify whether category name is to be displayed for the data labels of the entire series.
- Default value is <b>false</b>.
- </summary>
- <remarks>
- Value defined for this property can be overridden for an individual data label with using the
- <see cref="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowCategoryName" /> property.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.ShowBubbleSize">
- <summary>
- Allows to specify whether bubble size is to be displayed for the data labels of the entire series.
- Applies only to Bubble charts.
- Default value is <b>false</b>.
- </summary>
- <remarks>
- Value defined for this property can be overridden for an individual data label with using the
- <see cref="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowBubbleSize" /> property.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.ShowLegendKey">
- <summary>
- Allows to specify whether legend key is to be displayed for the data labels of the entire series.
- Default value is <b>false</b>.
- </summary>
- <remarks>
- Value defined for this property can be overridden for an individual data label with using the
- <see cref="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowLegendKey" /> property.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.ShowPercentage">
- <summary>
- Allows to specify whether percentage value is to be displayed for the data labels of the entire series.
- Default value is <b>false</b>. Applies only to Pie charts.
- </summary>
- <remarks>
- Value defined for this property can be overridden for an individual data label with using the
- <see cref="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowPercentage" /> property.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.ShowSeriesName">
- <summary>
- Returns or sets a Boolean to indicate the series name display behavior for the data labels of the entire series.
- <b>True</b> to show the series name. <b>False</b> to hide. By default <b>false</b>.
- </summary>
- <remarks>
- Value defined for this property can be overridden for an individual data label with using the
- <see cref="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowSeriesName" /> property.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.ShowValue">
- <summary>
- Allows to specify whether values are to be displayed in the data labels of the entire series.
- Default value is <b>false</b>.
- </summary>
- <remarks>
- Value defined for this property can be overridden for an individual data label with using the
- <see cref="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowValue" /> property.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.ShowLeaderLines">
- <summary>
- Allows to specify whether data label leader lines need be shown for the data labels of the entire series.
- Default value is <b>false</b>.
- </summary>
- <remarks>
- <para>Applies to Pie charts only.
- Leader lines create a visual connection between a data label and its corresponding data point.</para>
- <para>Value defined for this property can be overridden for an individual data label with using the
- <see cref="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowLeaderLines" /> property.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.ShowDataLabelsRange">
- <summary>
- Allows to specify whether values from data labels range to be displayed in the data labels of the entire series.
- Default value is <b>false</b>.
- </summary>
- <remarks>
- Value defined for this property can be overridden for an individual data label with using the
- <see cref="P:Aspose.Words.Drawing.Charts.ChartDataLabel.ShowDataLabelsRange" /> property.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.Separator">
- <summary>
- Gets or sets string separator used for the data labels of the entire series.
- The default is a comma, except for pie charts showing only category name and percentage, when a line break
- shall be used instead.
- </summary>
- <remarks>
- Value defined for this property can be overridden for an individual data label with using the
- <see cref="P:Aspose.Words.Drawing.Charts.ChartDataLabel.Separator" /> property.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataLabelCollection.NumberFormat">
- <summary>
- Gets an <see cref="T:Aspose.Words.Drawing.Charts.ChartNumberFormat" /> instance allowing to set number format for the data labels of the
- entire series.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.ChartDataPoint">
- <summary>
- Allows to specify formatting of a single data point on the chart.
- </summary>
- <remarks>
- On a series, the <see cref="T:Aspose.Words.Drawing.Charts.ChartDataPoint" /> object is a member of the <see cref="T:Aspose.Words.Drawing.Charts.ChartDataPointCollection" />.
- The <see cref="T:Aspose.Words.Drawing.Charts.ChartDataPointCollection" /> contains a <see cref="T:Aspose.Words.Drawing.Charts.ChartDataPoint" /> object for each point.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataPoint.Index">
- <summary>
- Index of the data point this object applies formatting to.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.ChartDataPointCollection">
- <summary>
- Represents collection of a <see cref="T:Aspose.Words.Drawing.Charts.ChartDataPoint" />.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartDataPointCollection.GetEnumerator">
- <summary>
- Returns an enumerator object.
- </summary>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartDataPointCollection.Add(System.Int32)">
- <summary>
- Adds new <see cref="T:Aspose.Words.Drawing.Charts.ChartDataPoint" /> at the specified index.
- </summary>
- <param name="index">Target data point index.</param>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartDataPointCollection.RemoveAt(System.Int32)">
- <summary>
- Removes a <see cref="T:Aspose.Words.Drawing.Charts.ChartDataPoint" /> at the specified index.
- </summary>
- <param name="index">The zero-based index of the bookmark to remove.</param>
- </member>
- <member name="M:Aspose.Words.Drawing.Charts.ChartDataPointCollection.Clear">
- <summary>
- Removes all <see cref="T:Aspose.Words.Drawing.Charts.ChartDataPoint" /> from this collection.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataPointCollection.Item(System.Int32)">
- <summary>
- Returns <see cref="T:Aspose.Words.Drawing.Charts.ChartDataPoint" /> for the specified index.
- If there is no ChartDataPoint for the specified index,
- returns default series ChartDataPoint.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartDataPointCollection.Count">
- <summary>
- Returns the number of <see cref="T:Aspose.Words.Drawing.Charts.ChartDataPoint" /> in this collection.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.AxisDisplayUnit">
- <summary>
- Provides access to the scaling options of the display units for the value axis.
- </summary>
- <dev>
- Corresponds to the dispUnits element (5.7.2.45, 21.2.2.45).
- </dev>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.AxisDisplayUnit.Unit">
- <summary>
- Gets or sets the scaling value of the display units as one of the predefined values.
- </summary>
- <remarks>
- Default value is <see cref="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.None" />. The <see cref="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.Custom" /> and
- <see cref="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.Percentage" /> values are not available in some chart types; see
- <see cref="T:Aspose.Words.Drawing.Charts.AxisBuiltInUnit" /> for more information.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.AxisDisplayUnit.CustomUnit">
- <summary>
- Gets or sets a user-defined divisor to scale display units on the value axis.
- </summary>
- <remarks>
- <para>The property is not supported by MS Office 2016 new charts. Default value is 1.</para>
- <para>Setting this property sets the <see cref="P:Aspose.Words.Drawing.Charts.AxisDisplayUnit.Unit" /> property to
- <see cref="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.Custom" />.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.AxisDisplayUnit.Document">
- <summary>
- Returns the Document the title holder belongs.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.ChartLegend">
- <summary>
- Represents chart legend properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartLegend.Position">
- <summary>
- Specifies the position of the legend on a chart.
- Default value is <see cref="F:Aspose.Words.Drawing.Charts.LegendPosition.Right" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartLegend.Overlay">
- <summary>
- Determines whether other chart elements shall be allowed to overlap legend.
- Default value is false.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.ChartMarker">
- <summary>
- Represents a chart data marker.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartMarker.Symbol">
- <summary>
- Gets or sets chart marker symbol.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartMarker.Size">
- <summary>
- Gets or sets chart marker size.
- Default value is 7.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.AxisScaling">
- <summary>
- Represents the scaling options of the axis.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.AxisScaling.Type">
- <summary>
- Gets or sets scaling type of the axis.
- </summary>
- <remarks>
- The <see cref="F:Aspose.Words.Drawing.Charts.AxisScaleType.Linear" /> value is the only that is allowed in MS Office 2016 new charts.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.AxisScaling.LogBase">
- <summary>
- Gets or sets the logarithmic base for a logarithmic axis.
- </summary>
- <remarks>
- <para>The property is not supported by MS Office 2016 new charts.</para>
- <para>Valid range of a floating point value is greater than or equal to 2 and less than or
- equal to 1000. The property has effect only if <see cref="P:Aspose.Words.Drawing.Charts.AxisScaling.Type" /> is set to
- <see cref="F:Aspose.Words.Drawing.Charts.AxisScaleType.Logarithmic" />.</para>
- <para>Setting this property sets the <see cref="P:Aspose.Words.Drawing.Charts.AxisScaling.Type" /> property to <see cref="F:Aspose.Words.Drawing.Charts.AxisScaleType.Logarithmic" />.
- </para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.AxisScaling.Minimum">
- <summary>
- Gets or sets minimum value of the axis.
- </summary>
- <remarks>
- The default value is "auto".
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.AxisScaling.Maximum">
- <summary>
- Gets or sets the maximum value of the axis.
- </summary>
- <remarks>
- The default value is "auto".
- </remarks>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.ChartTitle">
- <summary>
- Provides access to the chart title properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartTitle.Text">
- <summary>
- Gets or sets the text of the chart title.
- If null or empty value is specified, auto generated title will be shown.
- </summary>
- <remarks>Use <see cref="P:Aspose.Words.Drawing.Charts.ChartTitle.Show" /> option if you need to hide the Title.</remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartTitle.Overlay">
- <summary>
- Determines whether other chart elements shall be allowed to overlap title.
- By default overlay is false.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartTitle.Show">
- <summary>
- Determines whether the title shall be shown for this chart.
- Default value is true.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.ChartAxis">
- <summary>
- Represents the axis options of the chart.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.Type">
- <summary>
- Returns type of the axis.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.CategoryType">
- <summary>
- Gets or sets type of the category axis.
- </summary>
- <remarks>
- Only text categories (<see cref="F:Aspose.Words.Drawing.Charts.AxisCategoryType.Category" />) are allowed in MS Office 2016 new charts.
- </remarks>
- <dev>
- The property is internally represented as two bool attributes since the <see cref="T:Aspose.Words.Drawing.Charts.AxisCategoryType" /> type
- provides no enough information that is needed to store the property in document file.
- </dev>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.Crosses">
- <summary>
- Specifies how this axis crosses the perpendicular axis.
- </summary>
- <remarks>
- <para>Default value is <see cref="F:Aspose.Words.Drawing.Charts.AxisCrosses.Automatic" />.</para>
- <para>The property is not supported by MS Office 2016 new charts.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.CrossesAt">
- <summary>
- Specifies where on the perpendicular axis the axis crosses.
- </summary>
- <remarks>
- <para>The property has effect only if <see cref="P:Aspose.Words.Drawing.Charts.ChartAxis.Crosses" /> are set to <see cref="F:Aspose.Words.Drawing.Charts.AxisCrosses.Custom" />.
- It is not supported by MS Office 2016 new charts.</para>
- <para>The units are determined by the type of axis. When the axis is a value axis, the value of the property
- is a decimal number on the value axis. When the axis is a time category axis, the value is defined as
- an integer number of days relative to the base date (30/12/1899). For a text category axis, the value is
- an integer category number, starting with 1 as the first category.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.ReverseOrder">
- <summary>
- Returns or sets a flag indicating whether values of axis should be displayed in reverse order, i.e.
- from max to min.
- </summary>
- <remarks>
- The property is not supported by MS Office 2016 new charts. Default value is <b>false</b>.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.MajorTickMark">
- <summary>
- Returns or sets the major tick marks.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.MinorTickMark">
- <summary>
- Returns or sets the minor tick marks for the axis.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.TickLabelPosition">
- <summary>
- Returns or sets the position of the tick labels on the axis.
- </summary>
- <remarks>
- The property is not supported by MS Office 2016 new charts.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.MajorUnit">
- <summary>
- Returns or sets the distance between major tick marks.
- </summary>
- <remarks>
- <para>Valid range of a value is greater than zero. The property has effect for time category and
- value axes.</para>
- <para>Setting this property sets the <see cref="P:Aspose.Words.Drawing.Charts.ChartAxis.MajorUnitIsAuto" /> property to <b>false</b>.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.MajorUnitIsAuto">
- <summary>
- Gets or sets a flag indicating whether default distance between major tick marks shall be used.
- </summary>
- <remarks>
- The property has effect for time category and value axes.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.MajorUnitScale">
- <summary>
- Returns or sets the scale value for major tick marks on the time category axis.
- </summary>
- <remarks>
- The property has effect only for time category axes.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.MinorUnit">
- <summary>
- Returns or sets the distance between minor tick marks.
- </summary>
- <remarks>
- <para>Valid range of a value is greater than zero. The property has effect for time category and
- value axes.</para>
- <para>Setting this property sets the <see cref="P:Aspose.Words.Drawing.Charts.ChartAxis.MinorUnitIsAuto" /> property to <b>false</b>.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.MinorUnitIsAuto">
- <summary>
- Gets or sets a flag indicating whether default distance between minor tick marks shall be used.
- </summary>
- <remarks>
- The property has effect for time category and value axes.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.MinorUnitScale">
- <summary>
- Returns or sets the scale value for minor tick marks on the time category axis.
- </summary>
- <remarks>
- The property has effect only for time category axes.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.BaseTimeUnit">
- <summary>
- Returns or sets the smallest time unit that is represented on the time category axis.
- </summary>
- <remarks>
- The property has effect only for time category axes.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.NumberFormat">
- <summary>
- Returns a <see cref="T:Aspose.Words.Drawing.Charts.ChartNumberFormat" /> object that allows defining number formats for the axis.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.TickLabelOffset">
- <summary>
- Gets or sets the distance of labels from the axis.
- </summary>
- <remarks>
- <para>The property represents a percentage of the default label offset.</para>
- <para>Valid range is from 0 to 1000 percent inclusive. Default value is 100%.</para>
- <para>The property has effect only for category axes. It is not supported by MS Office 2016 new charts.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.DisplayUnit">
- <summary>
- Specifies the scaling value of the display units for the value axis.
- </summary>
- <remarks>
- The property has effect only for value axes.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.AxisBetweenCategories">
- <summary>
- Gets or sets a flag indicating whether the value axis crosses the category axis between categories.
- </summary>
- <remarks>
- The property has effect only for value axes. It is not supported by MS Office 2016 new charts.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.Scaling">
- <summary>
- Provides access to the scaling options of the axis.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.TickLabelSpacing">
- <summary>
- Gets or sets the interval, at which tick labels are drawn.
- </summary>
- <remarks>
- <para>The property has effect for text category and series axes. It is not supported by MS Office 2016
- new charts. Valid range of a value is greater than or equal to 1.</para>
- <para>Setting this property sets the <see cref="P:Aspose.Words.Drawing.Charts.ChartAxis.TickLabelSpacingIsAuto" /> property to <b>false</b>.</para>
- </remarks>
- <dev>
- The ISO standard states that this element specifies how many tick labels to skip between label that is drawn.
- In MS Office, this element specifies the interval at which tick labels are drawn.
- </dev>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.TickLabelSpacingIsAuto">
- <summary>
- Gets or sets a flag indicating whether automatic interval of drawing tick labels shall be used.
- </summary>
- <remarks>
- <para>Default value is <b>true</b>.</para>
- <para>The property has effect for text category and series axes. It is not supported by MS Office 2016
- new charts.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.TickLabelAlignment">
- <summary>
- Gets or sets text alignment of axis tick labels.
- </summary>
- <remarks>
- <para>This property has effect only for multi-line labels.</para>
- <para>Default value is <see cref="F:Aspose.Words.ParagraphAlignment.Center" />.</para>.
- </remarks>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.TickMarkSpacing">
- <summary>
- Gets or sets the interval, at which tick marks are drawn.
- </summary>
- <remarks>
- <para>The property has effect for text category and series axes. It is not supported by MS Office 2016
- new charts.</para>
- <para>Valid range of a value is greater than or equal to 1.</para>
- </remarks>
- <dev>
- The ISO standard states that this element specifies how many tick marks shall be skipped before the next
- one shall be drawn.
- In MS Office, this element specifies the interval at which tick marks are drawn.
- </dev>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.Hidden">
- <summary>
- Gets or sets a flag indicating whether this axis is hidden or not.
- </summary>
- <remarks>
- Default value is <b>false</b>.
- </remarks>
- <dev>
- Corresponds to the 21.2.2.40 delete element [ISO/IEC 29500] and to the hidden attribute of the 2.24.3.3
- CT_Axis complex type [MS-ODRAWXML].
- </dev>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartAxis.Document">
- <summary>
- Returns the Document the title holder belongs.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.ChartAxisType">
- <summary>
- Specifies type of chart axis.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartAxisType.Category">
- <summary>
- Category axis of a chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartAxisType.Series">
- <summary>
- Series axis of a chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.ChartAxisType.Value">
- <summary>
- Value axis of a chart.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.ChartSeries">
- <summary>
- Represents chart series properties.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartSeries.DataPoints">
- <summary>
- Returns a collection of formatting objects for all data points in this series.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartSeries.Name">
- <summary>
- Gets or sets the name of the series, if name is not set explicitly it is generated using index.
- By default returns Series plus one based index.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartSeries.Smooth">
- <summary>
- Allows to specify whether the line connecting the points on the chart shall be smoothed using Catmull-Rom splines.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartSeries.HasDataLabels">
- <summary>
- Gets or sets a flag indicating whether data labels are displayed for the series.
- </summary>
- </member>
- <member name="P:Aspose.Words.Drawing.Charts.ChartSeries.DataLabels">
- <summary>
- Specifies the settings for the data labels for the entire series.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.AxisBuiltInUnit">
- <summary>
- Specifies the display units for an axis.
- </summary>
- <dev>
- Corresponds to the ST_BuiltInUnit simple type (5.7.3.6).
- </dev>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.None">
- <summary>
- Specifies the values on the chart shall displayed as is.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.Custom">
- <summary>
- Specifies the values on the chart shall be divided by a user-defined divisor. This value is not supported
- by the new chart types of MS Office 2016.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.Billions">
- <summary>
- Specifies the values on the chart shall be divided by 1,000,000,000.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.HundredMillions">
- <summary>
- Specifies the values on the chart shall be divided by 100,000,000.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.Hundreds">
- <summary>
- Specifies the values on the chart shall be divided by 100.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.HundredThousands">
- <summary>
- Specifies the values on the chart shall be divided by 100,000.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.Millions">
- <summary>
- Specifies the values on the chart shall be divided by 1,000,000.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.TenMillions">
- <summary>
- Specifies the values on the chart shall be divided by 10,000,000.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.TenThousands">
- <summary>
- Specifies the values on the chart shall be divided by 10,000.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.Thousands">
- <summary>
- Specifies the values on the chart shall be divided by 1,000.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.Trillions">
- <summary>
- Specifies the values on the chart shall be divided by 1,000,000,000,0000.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisBuiltInUnit.Percentage">
- <summary>
- Specifies the values on the chart shall be divided by 0.01. This value is supported only by the new chart
- types of MS Office 2016.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.AxisCrosses">
- <summary>
- Specifies the possible crossing points for an axis.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisCrosses.Automatic">
- <summary>
- The category axis crosses at the zero point of the value axis (if possible), or at the minimum value
- if the minimum is greater than zero, or at the maximum if the maximum is less than zero.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisCrosses.Maximum">
- <summary>
- A perpendicular axis crosses at the maximum value of the axis.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisCrosses.Minimum">
- <summary>
- A perpendicular axis crosses at the minimum value of the axis.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisCrosses.Custom">
- <summary>
- A perpendicular axis crosses at the specified value of the axis.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.LegendPosition">
- <summary>
- Specifies the possible positions for a chart legend.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.LegendPosition.None">
- <summary>
- No legend will be shown for the chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.LegendPosition.Bottom">
- <summary>
- Specifies that the legend shall be drawn at the bottom of the chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.LegendPosition.Left">
- <summary>
- Specifies that the legend shall be drawn at the left of the chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.LegendPosition.Right">
- <summary>
- Specifies that the legend shall be drawn at the right of the chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.LegendPosition.Top">
- <summary>
- Specifies that the legend shall be drawn at the top of the chart.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.LegendPosition.TopRight">
- <summary>
- Specifies that the legend shall be drawn at the top right of the chart.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.MarkerSymbol">
- <summary>
- Specifies marker symbol style.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.MarkerSymbol.Default">
- <summary>
- Specifies a default marker symbol shall be drawn at each data point.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.MarkerSymbol.Circle">
- <summary>
- Specifies a circle shall be drawn at each data point.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.MarkerSymbol.Dash">
- <summary>
- Specifies a dash shall be drawn at each data point.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.MarkerSymbol.Diamond">
- <summary>
- Specifies a diamond shall be drawn at each data point.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.MarkerSymbol.Dot">
- <summary>
- Specifies a dot shall be drawn at each data point.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.MarkerSymbol.None">
- <summary>
- Specifies nothing shall be drawn at each data point.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.MarkerSymbol.Picture">
- <summary>
- Specifies a picture shall be drawn at each data point.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.MarkerSymbol.Plus">
- <summary>
- Specifies a plus shall be drawn at each data point.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.MarkerSymbol.Square">
- <summary>
- Specifies a square shall be drawn at each data point.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.MarkerSymbol.Star">
- <summary>
- Specifies a star shall be drawn at each data point.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.MarkerSymbol.Triangle">
- <summary>
- Specifies a triangle shall be drawn at each data point.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.MarkerSymbol.X">
- <summary>
- Specifies an X shall be drawn at each data point.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.AxisTickLabelPosition">
- <summary>
- Specifies the possible positions for tick labels.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisTickLabelPosition.High">
- <summary>
- Specifies the axis labels shall be at the high end of the perpendicular axis.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisTickLabelPosition.Low">
- <summary>
- Specifies the axis labels shall be at the low end of the perpendicular axis.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisTickLabelPosition.NextToAxis">
- <summary>
- Specifies the axis labels shall be next to the axis.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisTickLabelPosition.None">
- <summary>
- Specifies the axis labels are not drawn.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisTickLabelPosition.Default">
- <summary>
- Specifies default value of tick labels position.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.AxisTickMark">
- <summary>
- Specifies the possible positions for tick marks.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisTickMark.Cross">
- <summary>
- Specifies that the tick marks shall cross the axis.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisTickMark.Inside">
- <summary>
- Specifies that the tick marks shall be inside the plot area.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisTickMark.Outside">
- <summary>
- Specifies that the tick marks shall be outside the plot area.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisTickMark.None">
- <summary>
- Specifies that there shall be no tick marks.
- </summary>
- </member>
- <member name="T:Aspose.Words.Drawing.Charts.AxisTimeUnit">
- <summary>
- Specifies the unit of time for axes.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisTimeUnit.Automatic">
- <summary>
- Specifies that unit was not set explicitly and default value should be used.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisTimeUnit.Days">
- <summary>
- Specifies that the chart data shall be shown in days.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisTimeUnit.Months">
- <summary>
- Specifies that the chart data shall be shown in months.
- </summary>
- </member>
- <member name="F:Aspose.Words.Drawing.Charts.AxisTimeUnit.Years">
- <summary>
- Specifies that the chart data shall be shown in years.
- </summary>
- </member>
- <member name="T:Aspose.Words.Layout.IPageLayoutCallback">
- <summary>
- Implement this interface if you want to have your own custom method called during build and rendering of page layout model.
- </summary>
- <remarks>
- The primary use for this interface is to allow application code to abort build process.<para />
- It is possible to build page layout model for only a few pages at start of the document then abort process and render only what has been built already.<para />
- Note, however, that rendering results may not match what would be rendered for each page if process would have finished.<para />
- This technique may not work for every document or may fail completely.<para /></remarks>
- <seealso cref="P:Aspose.Words.Layout.LayoutOptions.Callback" />
- </member>
- <member name="M:Aspose.Words.Layout.IPageLayoutCallback.Notify(Aspose.Words.Layout.PageLayoutCallbackArgs)">
- <summary>
- This is called to notify of layout build and rendering progress.
- </summary>
- <param name="args">An argument of the event.</param>
- <remarks>
- Exception when thrown by implementation aborts layout build process.<para /></remarks>
- </member>
- <member name="T:Aspose.Words.Layout.PageLayoutCallbackArgs">
- <summary>
- An argument passed into <see cref="M:Aspose.Words.Layout.IPageLayoutCallback.Notify(Aspose.Words.Layout.PageLayoutCallbackArgs)" /></summary>
- </member>
- <member name="P:Aspose.Words.Layout.PageLayoutCallbackArgs.Event">
- <summary>
- Gets event.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.PageLayoutCallbackArgs.Document">
- <summary>
- Gets document.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.PageLayoutCallbackArgs.PageIndex">
- <summary>
- Gets 0-based index of the page in the document this event relates to.
- Returns negative value if there is no associated page, or if page was removed during reflow.
- </summary>
- </member>
- <member name="T:Aspose.Words.Layout.PageLayoutEvent">
- <summary>
- A code of event raised during page layout model build and rendering.<para />
-
- 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.<para />
-
- 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.<para /></summary>
- </member>
- <member name="F:Aspose.Words.Layout.PageLayoutEvent.None">
- <summary>
- Default value
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.PageLayoutEvent.WatchDog">
- <summary>
- Corresponds to a checkpoint in code which is often visited and which is suitable to abort process.<para />
- While inside <see cref="M:Aspose.Words.Layout.IPageLayoutCallback.Notify(Aspose.Words.Layout.PageLayoutCallbackArgs)" /> throw custom exception to abort process.<para />
- You can throw when handling any callback event to abort process.<para />
- Note that if process is aborted the page layout model remains in undefined state. If process is aborted upon reflow of a complete page,
- however, it should be possible to use layout model up to the end of that page.<para /></summary>
- </member>
- <member name="F:Aspose.Words.Layout.PageLayoutEvent.BuildStarted">
- <summary>
- Build of the page layout has started. Fired once.
- This is the first event which occurs when <see cref="M:Aspose.Words.Document.UpdatePageLayout" /> is called.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.PageLayoutEvent.BuildFinished">
- <summary>
- Build of the page layout has finished. Fired once.
- This is the last event which occurs when <see cref="M:Aspose.Words.Document.UpdatePageLayout" /> is called.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.PageLayoutEvent.ConversionStarted">
- <summary>
- Conversion of document model to page layout has started. Fired once.
- This occurs when layout model starts pulling document content.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.PageLayoutEvent.ConversionFinished">
- <summary>
- Conversion of document model to page layout has finished. Fired once.
- This occurs when layout model stops pulling document content.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.PageLayoutEvent.ReflowStarted">
- <summary>
- Reflow of the page layout has started. Fired once.
- This occurs when layout model starts reflowing document content.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.PageLayoutEvent.ReflowFinished">
- <summary>
- Reflow of the page layout has finished. Fired once.
- This occurs when layout model stops reflowing document content.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.PageLayoutEvent.PartReflowStarted">
- <summary>
- Reflow of the page has started.
- Note that page may reflow multiple times and that reflow may restart before it is finished.
- <seealso cref="P:Aspose.Words.Layout.PageLayoutCallbackArgs.PageIndex" /></summary>
- </member>
- <member name="F:Aspose.Words.Layout.PageLayoutEvent.PartReflowFinished">
- <summary>
- Reflow of the page has finished.
- Note that page may reflow multiple times and that reflow may restart before it is finished.
- <seealso cref="P:Aspose.Words.Layout.PageLayoutCallbackArgs.PageIndex" /></summary>
- </member>
- <member name="F:Aspose.Words.Layout.PageLayoutEvent.PartRenderingStarted">
- <summary>
- Rendering of page has started. This is fired once per page.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.PageLayoutEvent.PartRenderingFinished">
- <summary>
- Rendering of page has finished. This is fired once per page.
- </summary>
- </member>
- <member name="T:Aspose.Words.Layout.ShowInBalloons">
- <summary>
- Specifies which revisions are rendered in balloons.
- </summary>
- <remarks>
- Note that these values do not affect rendering of comments, which are controlled by <see cref="P:Aspose.Words.Layout.LayoutOptions.ShowComments" />.
- </remarks>
- </member>
- <member name="F:Aspose.Words.Layout.ShowInBalloons.None">
- <summary>
- Renders insert, delete and format revisions inline.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.ShowInBalloons.Format">
- <summary>
- Renders insert and delete revisions inline, format revisions in balloons.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.ShowInBalloons.FormatAndDelete">
- <summary>
- Renders insert revisions inline, delete and format revisions in balloons.
- </summary>
- </member>
- <member name="T:Aspose.Words.Layout.RevisionTextEffect">
- <summary>
- Allows to specify decoration effect for revisions of document text.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionTextEffect.None">
- <summary>
- Revised content has no special effects applied.
- This corresponds to <see cref="F:Aspose.Words.Layout.RevisionColor.NoHighlight" />.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionTextEffect.Color">
- <summary>
- Revised content is highlighted with color only.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionTextEffect.Bold">
- <summary>
- Revised content is made bold and colored.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionTextEffect.Italic">
- <summary>
- Revised content is made italic and colored.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionTextEffect.Underline">
- <summary>
- Revised content is underlined and colored.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionTextEffect.DoubleUnderline">
- <summary>
- Revised content is double underlined and colored.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionTextEffect.StrikeThrough">
- <summary>
- Revised content is stroked through and colored.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionTextEffect.DoubleStrikeThrough">
- <summary>
- Revised content is double stroked through and colored.
- </summary>
- <remarks>Only works for <see cref="F:Aspose.Words.RevisionType.Deletion" />, <see cref="F:Aspose.Words.RevisionType.FormatChange" /> and <see cref="F:Aspose.Words.RevisionType.Moving" /> ('move from' type).</remarks>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionTextEffect.Hidden">
- <summary>
- Revised content is hidden.
- </summary>
- <remarks>Only works for <see cref="F:Aspose.Words.RevisionType.Deletion" /> and <see cref="F:Aspose.Words.RevisionType.Moving" /> ('move from' type).</remarks>
- </member>
- <member name="T:Aspose.Words.Layout.RevisionColor">
- <summary>
- Allows to specify color of document revisions.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.Auto">
- <summary>
- Default.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.Black">
- <summary>
- Represents 000000 color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.Blue">
- <summary>
- Represents 2e97d3 color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.BrightGreen">
- <summary>
- Represents 84a35b color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.DarkBlue">
- <summary>
- Represents 376e96 color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.DarkRed">
- <summary>
- Represents 881824 color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.DarkYellow">
- <summary>
- Represents e09a2b color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.Gray25">
- <summary>
- Represents a0a3a9 color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.Gray50">
- <summary>
- Represents 50565e color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.Green">
- <summary>
- Represents 2c6234 color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.Pink">
- <summary>
- Represents ce338f color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.Red">
- <summary>
- Represents b5082e color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.Teal">
- <summary>
- Represents 1b9cab color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.Turquoise">
- <summary>
- Represents 3eafc2 color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.Violet">
- <summary>
- Represents 633277 color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.White">
- <summary>
- Represents ffffff color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.Yellow">
- <summary>
- Represents fad272 color.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.NoHighlight">
- <summary>
- No color is used to highlight revision changes.
- </summary>
- <dev>
- We shall consider getting rid of this one as it duplicates <see cref="F:Aspose.Words.Layout.RevisionEffect.None" />.
- I believe it has no use if <see cref="T:Aspose.Words.Layout.RevisionEffect" /> is publicly available.
- It is confusing to use <see cref="F:Aspose.Words.Layout.RevisionColor.NoHighlight" /> and <see cref="F:Aspose.Words.Layout.RevisionEffect.Color" /> together,
- or <see cref="F:Aspose.Words.Layout.RevisionColor.ByAuthor" /> and <see cref="F:Aspose.Words.Layout.RevisionEffect.None" /> for example.
- </dev>
- </member>
- <member name="F:Aspose.Words.Layout.RevisionColor.ByAuthor">
- <summary>
- Revisions of each author receive their own color for highlighting from a predfined set of hi-contrast colors.
- </summary>
- </member>
- <member name="T:Aspose.Words.Layout.RevisionOptions">
- <summary>
- Allows to control how document revisions are handled during layout process.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.ShowRevisionMarks">
- <summary>
- Allow to specify whether revision text should be marked with special formatting markup.
- Default value is True.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.ShowRevisionBars">
- <summary>
- Allows to specify whether revision bars should be rendered near lines containing revised content.
- Default value is True.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.ShowOriginalRevision">
- <summary>
- Allows to specify whether the original text should be shown instead of revised one.
- Default value is False.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.InsertedTextColor">
- <summary>
- Allows to specify the color to be used for inserted content <see cref="F:Aspose.Words.RevisionType.Insertion" />.
- Default value is <see cref="F:Aspose.Words.Layout.RevisionColor.ByAuthor" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.InsertedTextEffect">
- <summary>
- Allows to specify the effect to be applied to the inserted content <see cref="F:Aspose.Words.RevisionType.Insertion" />.
- Default value is <see cref="F:Aspose.Words.Layout.RevisionTextEffect.Underline" />.
- </summary>
- <remarks>Values of <see cref="F:Aspose.Words.Layout.RevisionTextEffect.Hidden" /> and <see cref="F:Aspose.Words.Layout.RevisionTextEffect.DoubleStrikeThrough" />
- are not allowed and will cause <see cref="T:System.ArgumentOutOfRangeException" />.</remarks>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.DeletedTextColor">
- <summary>
- Allows to specify the color to be used for deleted content <see cref="F:Aspose.Words.RevisionType.Deletion" />.
- Default value is <see cref="F:Aspose.Words.Layout.RevisionColor.ByAuthor" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.DeletedTextEffect">
- <summary>
- Allows to specify the effect to be applied to the deleted content <see cref="F:Aspose.Words.RevisionType.Deletion" />.
- Default value is <see cref="F:Aspose.Words.Layout.RevisionTextEffect.StrikeThrough" /></summary>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.MovedFromTextColor">
- <summary>
- Allows to specify the color to be used for areas where content was moved from <see cref="F:Aspose.Words.RevisionType.Moving" />.
- Default value is <see cref="F:Aspose.Words.Layout.RevisionColor.ByAuthor" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.MovedFromTextEffect">
- <summary>
- Allows to specify the effect to be applied to the areas where content was moved from <see cref="F:Aspose.Words.RevisionType.Moving" />.
- Default value is <see cref="F:Aspose.Words.Layout.RevisionTextEffect.DoubleStrikeThrough" /></summary>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.MovedToTextColor">
- <summary>
- Allows to specify the color to be used for areas where content was moved to <see cref="F:Aspose.Words.RevisionType.Moving" />.
- Default value is <see cref="F:Aspose.Words.Layout.RevisionColor.ByAuthor" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.MovedToTextEffect">
- <summary>
- Allows to specify the effect to be applied to the areas where content was moved to <see cref="F:Aspose.Words.RevisionType.Moving" />.
- Default value is <see cref="F:Aspose.Words.Layout.RevisionTextEffect.DoubleUnderline" /></summary>
- <remarks>Values of <see cref="F:Aspose.Words.Layout.RevisionTextEffect.Hidden" /> and <see cref="F:Aspose.Words.Layout.RevisionTextEffect.DoubleStrikeThrough" />
- are not allowed and will cause <see cref="T:System.ArgumentOutOfRangeException" />.</remarks>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.RevisedPropertiesColor">
- <summary>
- Allows to specify the color to be used for content with changes of formatting properties <see cref="F:Aspose.Words.RevisionType.FormatChange" />
- Default value is <see cref="F:Aspose.Words.Layout.RevisionColor.NoHighlight" />.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.RevisedPropertiesEffect">
- <summary>
- Allows to specify the effect for content areas with changes of formatting properties <see cref="F:Aspose.Words.RevisionType.FormatChange" />
- Default value is <see cref="F:Aspose.Words.Layout.RevisionTextEffect.None" /></summary>
- <remarks>
- <see cref="F:Aspose.Words.Layout.RevisionTextEffect.Hidden" /> is not allowed and will cause <see cref="T:System.ArgumentOutOfRangeException" />.</remarks>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.RevisionBarsColor">
- <summary>
- Allows to specify the color to be used for side bars that identify document lines containing revised information.
- Default value is <see cref="F:Aspose.Words.Layout.RevisionColor.Red" />.
- </summary>
- <remarks> Setting this property to <see cref="F:Aspose.Words.Layout.RevisionColor.ByAuthor" /> or <see cref="F:Aspose.Words.Layout.RevisionColor.NoHighlight" /> values
- will result in hiding revision bars from the layout.</remarks>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.RevisionBarsWidth">
- <summary>
- Gets or sets width of revision bars, points.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.RevisionBarsPosition">
- <summary>
- Gets or sets rendering position of revision bars.
- Default value is <see cref="F:Aspose.Words.Drawing.HorizontalAlignment.Outside" />.
- </summary>
- <remarks>Values of <see cref="F:Aspose.Words.Drawing.HorizontalAlignment.Center" /> and <see cref="F:Aspose.Words.Drawing.HorizontalAlignment.Inside" />
- are not allowed and will cause <see cref="T:System.ArgumentOutOfRangeException" />.</remarks>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.CommentColor">
- <summary>
- Allows to specify the color to be used for comments.
- Default value is <see cref="F:Aspose.Words.Layout.RevisionColor.Red" />.
- </summary>
- <remarks> If set this property to <see cref="F:Aspose.Words.Layout.RevisionColor.ByAuthor" /> or <see cref="F:Aspose.Words.Layout.RevisionColor.NoHighlight" /> values,
- as the result this property will be set to default color.</remarks>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.ShowInBalloons">
- <summary>
- Allows to specify whether the revisions are rendered in the balloons.
- Default value is <see cref="F:Aspose.Words.Layout.ShowInBalloons.None" /></summary>
- </member>
- <member name="P:Aspose.Words.Layout.RevisionOptions.MeasurementUnit">
- <summary>
- Allows to specify the measurement units for revision comments.
- Default value is <see cref="F:Aspose.Words.MeasurementUnits.Centimeters" /></summary>
- </member>
- <member name="T:Aspose.Words.Layout.LayoutOptions">
- <summary>
- Holds the options that allow controlling the document layout process.
- </summary>
- <remarks>
- <para>
- You do not create instances of this class directly. Use the <see cref="P:Aspose.Words.Document.LayoutOptions" /> property to access layout options for this document.
- </para>
- <para>Note that after changing any of the options present in this class, <see cref="M:Aspose.Words.Document.UpdatePageLayout" /> method
- should be called in order for the changed options to be applied to the layout.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutOptions.RevisionOptions">
- <summary>
- Gets revision options.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutOptions.ShowHiddenText">
- <summary>
- Gets or sets indication of whether hidden text in the document is rendered.
- Default is False.
- </summary>
- <remarks>This property affects all hidden content, not just text.</remarks>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutOptions.ShowParagraphMarks">
- <summary>
- Gets or sets indication of whether paragraph marks are rendered.
- Default is False.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutOptions.ShowComments">
- <summary>
- Gets or sets indication of whether comments are rendered.
- Default is True.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutOptions.TextShaperFactory">
- <summary>
- Gets or sets <see cref="T:Aspose.Words.Shaping.ITextShaperFactory" /> implementation used for Advanced Typography rendering features.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutOptions.Callback">
- <summary>
- Gets or sets <see cref="T:Aspose.Words.Layout.IPageLayoutCallback" /> implementation used by page layout model.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutOptions.IgnorePrinterMetrics">
- <summary>
- Gets or sets indication of whether the "Use printer metrics to lay out document" compatibility option is ignored.
- Default is True.
- </summary>
- </member>
- <member name="T:Aspose.Words.Layout.LayoutEntityType">
- <summary>
- Types of the layout entities.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.LayoutEntityType.None">
- <summary>
- Default value.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.LayoutEntityType.Page">
- <summary>
- Represents page of a document.
-
- Page may have <see cref="F:Aspose.Words.Layout.LayoutEntityType.Column" />, <see cref="F:Aspose.Words.Layout.LayoutEntityType.HeaderFooter" /> and <see cref="F:Aspose.Words.Layout.LayoutEntityType.Comment" /> child entities.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.LayoutEntityType.Column">
- <summary>
- Represents a column of text on a page.
-
- Column may have the same child entities as <see cref="F:Aspose.Words.Layout.LayoutEntityType.Cell" />, plus <see cref="F:Aspose.Words.Layout.LayoutEntityType.Footnote" />, <see cref="F:Aspose.Words.Layout.LayoutEntityType.Endnote" /> and <see cref="F:Aspose.Words.Layout.LayoutEntityType.NoteSeparator" /> entities.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.LayoutEntityType.Row">
- <summary>
- Represents a table row.
-
- Row may have <see cref="F:Aspose.Words.Layout.LayoutEntityType.Cell" /> as child entities.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.LayoutEntityType.Cell">
- <summary>
- Represents a table cell.
-
- Cell may have <see cref="F:Aspose.Words.Layout.LayoutEntityType.Line" /> and <see cref="F:Aspose.Words.Layout.LayoutEntityType.Row" /> child entities.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.LayoutEntityType.Line">
- <summary>
- Represents line of characters of text and inline objects.
-
- Line may have <see cref="F:Aspose.Words.Layout.LayoutEntityType.Span" /> child entities.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.LayoutEntityType.Span">
- <summary>
- Represents one or more characters in a line.
- This include special characters like field start/end markers, bookmarks and comments.
-
- Span may not have child entities.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.LayoutEntityType.Footnote">
- <summary>
- Represents placeholder for footnote content.
-
- Footnote may have <see cref="F:Aspose.Words.Layout.LayoutEntityType.Line" /> and <see cref="F:Aspose.Words.Layout.LayoutEntityType.Row" /> child entities.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.LayoutEntityType.Endnote">
- <summary>
- Represents placeholder for endnote content.
-
- Endnote may have <see cref="F:Aspose.Words.Layout.LayoutEntityType.Line" /> and <see cref="F:Aspose.Words.Layout.LayoutEntityType.Row" /> child entities.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.LayoutEntityType.HeaderFooter">
- <summary>
- Represents placeholder for header/footer content on a page.
-
- HeaderFooter may have <see cref="F:Aspose.Words.Layout.LayoutEntityType.Line" /> and <see cref="F:Aspose.Words.Layout.LayoutEntityType.Row" /> child entities.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.LayoutEntityType.TextBox">
- <summary>
- Represents text area inside of a shape.
-
- Textbox may have <see cref="F:Aspose.Words.Layout.LayoutEntityType.Line" /> and <see cref="F:Aspose.Words.Layout.LayoutEntityType.Row" /> child entities.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.LayoutEntityType.Comment">
- <summary>
- Represents placeholder for comment content.
-
- Comment may have <see cref="F:Aspose.Words.Layout.LayoutEntityType.Line" /> and <see cref="F:Aspose.Words.Layout.LayoutEntityType.Row" /> child entities.
- </summary>
- </member>
- <member name="F:Aspose.Words.Layout.LayoutEntityType.NoteSeparator">
- <summary>
- Represents footnote/endnote separator.
-
- NoteSeparator may have <see cref="F:Aspose.Words.Layout.LayoutEntityType.Line" /> and <see cref="F:Aspose.Words.Layout.LayoutEntityType.Row" /> child entities.
- </summary>
- </member>
- <member name="T:Aspose.Words.Layout.LayoutCollector">
- <summary>
- <para>This class allows to compute page numbers of document nodes.</para>
- </summary>
- <remarks>
- <para>When you create a <see cref="T:Aspose.Words.Layout.LayoutCollector" /> and specify a <see cref="T:Aspose.Words.Document" /> document object to attach to,
- the collector will record mapping of document nodes to layout objects when the document is formatted into pages.</para>
- <para>You will be able to find out on which page a particular document node (e.g. run, paragraph or table cell) is located
- by using the <see cref="M:Aspose.Words.Layout.LayoutCollector.GetStartPageIndex(Aspose.Words.Node)" />, <see cref="M:Aspose.Words.Layout.LayoutCollector.GetEndPageIndex(Aspose.Words.Node)" /> and <see cref="M:Aspose.Words.Layout.LayoutCollector.GetNumPagesSpanned(Aspose.Words.Node)" /> methods.
- These methods automatically build page layout model of the document and update fields if required.</para>
- <para>When you no longer need to collect layout information, it is best to set the <see cref="P:Aspose.Words.Layout.LayoutCollector.Document" /> property to null
- to avoid unnecessary collection of more layout mappings.</para>
- </remarks>
- <dev>
- !!! DO NOT USE THIS CLASS INTERNALLY IN AW. CONTACT LAYOUT TEAM FOR YOUR CUSTOM SOLUTION FIRST !!!
- </dev>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutCollector.#ctor(Aspose.Words.Document)">
- <summary>
- Initializes an instance of this class.
- </summary>
- <param name="doc">The document to which this collector instance will be attached to.</param>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutCollector.GetStartPageIndex(Aspose.Words.Node)">
- <summary>
- Gets 1-based index of the page where node begins. Returns 0 if node cannot be mapped to a page.
- </summary>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutCollector.GetEndPageIndex(Aspose.Words.Node)">
- <summary>
- Gets 1-based index of the page where node ends. Returns 0 if node cannot be mapped to a page.
- </summary>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutCollector.GetNumPagesSpanned(Aspose.Words.Node)">
- <summary>
- Gets number of pages the specified node spans. 0 if node is within a single page.
- This is the same as <see cref="M:Aspose.Words.Layout.LayoutCollector.GetEndPageIndex(Aspose.Words.Node)" /> - <see cref="M:Aspose.Words.Layout.LayoutCollector.GetStartPageIndex(Aspose.Words.Node)" />.
- </summary>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutCollector.Clear">
- <summary>
- Clears all collected layout data. Call this method after document was manually updated, or layout was rebuilt.
- </summary>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutCollector.GetEntity(Aspose.Words.Node)">
- <summary>
- Returns an opaque position of the <see cref="T:Aspose.Words.Layout.LayoutEnumerator" /> which corresponds to the specified node.
- You can use returned value as an argument to <see cref="P:Aspose.Words.Layout.LayoutEnumerator.Current" /> given the document being
- enumerated and the document of the node are the same.
- </summary>
- <remarks>
- <para>This method works for only <see cref="T:Aspose.Words.Paragraph" /> nodes, as well as indivisible inline nodes,
- e.g. <see cref="T:Aspose.Words.BookmarkStart" /> or <see cref="T:Aspose.Words.Drawing.Shape" />. It doesn't work for <see cref="T:Aspose.Words.Run" />, <see cref="T:Aspose.Words.Tables.Cell" /><see cref="T:Aspose.Words.Tables.Row" /> or <see cref="T:Aspose.Words.Tables.Table" /> nodes, and nodes within header/footer.</para>
- <para>Note that the entity returned for a <see cref="T:Aspose.Words.Paragraph" /> node is a paragraph break span. Use the appropriate method to ascend to the parent line</para>
- <para>If you need to navigate to a <see cref="T:Aspose.Words.Run" /> of text then you can insert bookmark right before it
- and then navigate to the bookmark instead.</para>
- <para>If you need to navigate to a <see cref="T:Aspose.Words.Tables.Cell" /> node then you can move to a <see cref="T:Aspose.Words.Paragraph" />
- node in this cell and then ascend to a parent entity. The same approach can be used for <see cref="T:Aspose.Words.Tables.Row" />
- and <see cref="T:Aspose.Words.Tables.Table" /> nodes.</para>
- </remarks>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutCollector.Document">
- <summary>
- Gets or sets the document this collector instance is attached to.
- </summary>
- <remarks>
- If you need to access page indexes of the document nodes you need to set this property to point to a document instance,
- before page layout of the document is built. It is best to set this property to <c>null</c> afterwards,
- otherwise the collector continues to accumulate information from subsequent rebuilds of the document's page layout.
- </remarks>
- </member>
- <member name="T:Aspose.Words.Layout.LayoutEnumerator">
- <summary>
- 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 <see cref="M:Aspose.Words.Layout.LayoutCollector.GetEntity(Aspose.Words.Node)" /> and <see cref="P:Aspose.Words.Layout.LayoutEnumerator.Current" /> move to the entity which corresponds to a document node.
- </summary>
- <dev>
- !!! DO NOT USE THIS CLASS INTERNALLY IN AW. CONTACT LAYOUT TEAM FOR YOUR CUSTOM SOLUTION FIRST !!!
- </dev>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutEnumerator.#ctor(Aspose.Words.Document)">
- <summary>
- Initializes new instance of this class.
- </summary>
- <param name="document">A document whose page layout model to enumerate.</param>
- <remarks>
- <para>If page layout model of the document hasn't been built the enumerator calls <see cref="M:Aspose.Words.Document.UpdatePageLayout" /> to build it.</para>
- <para>Whenever document is updated and new page layout model is created, a new enumerator must be used to access it.</para>
- </remarks>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutEnumerator.Reset">
- <summary>
- Moves the enumerator to the first page of the document.
- </summary>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutEnumerator.MoveNext">
- <summary>
- Moves to the next sibling entity in visual order.
-
- When iterating lines of a paragraph broken across pages this method
- will not move to the next page but rather move to the next entity on the same page.
- </summary>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutEnumerator.MoveNextLogical">
- <summary>
- Moves to the next sibling entity in a logical order.
-
- When iterating lines of a paragraph broken across pages this method
- will move to the next line even if it resides on another page.
- </summary>
- <remarks>
- Note that all <see cref="F:Aspose.Words.Layout.LayoutEntityType.Span" /> entities are linked together thus if <see cref="P:Aspose.Words.Layout.LayoutEnumerator.Current" />
- entity is span repeated calling of this method will iterates complete story of the document.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutEnumerator.MovePrevious">
- <summary>
- Moves to the previous sibling entity.
- </summary>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutEnumerator.MovePreviousLogical">
- <summary>
- Moves to the previous sibling entity in a logical order.
-
- When iterating lines of a paragraph broken across pages this method
- will move to the previous line even if it resides on another page.
- </summary>
- <remarks>
- Note that all <see cref="F:Aspose.Words.Layout.LayoutEntityType.Span" /> entities are linked together thus if <see cref="P:Aspose.Words.Layout.LayoutEnumerator.Current" />
- entity is span repeated calling of this method will iterates complete story of the document.
- </remarks>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutEnumerator.MoveFirstChild">
- <summary>
- Moves to the first child entity.
- </summary>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutEnumerator.MoveLastChild">
- <summary>
- Moves to the last child entity.
- </summary>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutEnumerator.MoveParent">
- <summary>
- Moves to the parent entity.
- </summary>
- </member>
- <member name="M:Aspose.Words.Layout.LayoutEnumerator.MoveParent(Aspose.Words.Layout.LayoutEntityType)">
- <summary>
- Moves to the parent entity of the specified type.
- </summary>
- <param name="types">The parent entity type to move to. Use bitwise-OR to specify multiple parent types.</param>
- <remarks>This method is useful if you need to find the cell, column or header/footer parent of the entity.</remarks>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutEnumerator.Type">
- <summary>
- Gets the type of the current entity.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutEnumerator.Rectangle">
- <summary>
- Returns the bounding rectangle of the current entity relative to the page top left corner (in points).
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutEnumerator.Kind">
- <summary>
- Gets the kind of the current entity. This can be an empty string but never null.
- </summary>
- <remarks>This is a more specific type of the current entity, e.g. bookmark span has <see cref="F:Aspose.Words.Layout.LayoutEntityType.Span" /> type and
- may have either a BOOKMARKSTART or BOOKMARKEND kind.</remarks>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutEnumerator.Text">
- <summary>
- Gets text of the current span entity. Throws for other entity types.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutEnumerator.PageIndex">
- <summary>
- Gets the 1-based index of a page which contains the current entity.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutEnumerator.Current">
- <summary>
- Gets or sets current position in the page layout model.
- This property returns an opaque object which corresponds to the current layout entity.
- </summary>
- </member>
- <member name="P:Aspose.Words.Layout.LayoutEnumerator.Document">
- <summary>
- Gets document this instance enumerates.
- </summary>
- </member>
- <member name="T:Aspose.Words.Layout.NamespaceDoc">
- <summary>
- <p>The <b>Aspose.Words.Layout</b> namespace provides classes that allow to access
- information such as on what page and where on a page particular document elements
- are positioned, when the document is formatted into pages.</p>
- </summary>
- </member>
- </members>
- </doc>
|