Aspose.Words for .NET 24.8 Release Notes

/// <summary>
/// Gets or sets the orientation of the tick label text.
/// </summary>
/// <remarks>
/// The default value is ShapeTextOrientation.Horizontal.
/// Note that some ShapeTextOrientation values do not affect the orientation of tick label text in value axes.
/// </remarks>
public ShapeTextOrientation Orientation { get; set; }

/// <summary>
/// Gets or sets the rotation of the tick labels in degrees.
/// </summary>
/// <remarks>
/// The range of acceptable values is from -180 to 180 inclusive. The default value is 0.
/// </remarks>
public int Rotation { get; set; }

/// <summary>
/// Represents embedding licensing rights for the font.
/// </summary>
/// <remarks>
/// To learn more, visit the
/// <a href="https://learn.microsoft.com/en-us/typography/opentype/spec/os2#fstype">OpenType specification section</a>
/// on Microsoft Typography portal.
/// </remarks>
public class FontEmbeddingLicensingRights
{
    /// <summary>
    /// Usage permissions.
    /// </summary>
    public FontEmbeddingUsagePermissions EmbeddingUsagePermissions { get; }

    /// <summary>
    /// Indicates the "No subsetting" restriction.
    /// </summary>
    /// <remarks>
    /// When this flag is set, the font must not be subsetted prior to embedding. Other embedding restrictions
    /// also apply.
    /// </remarks>
    public bool NoSubsetting { get; }

    /// <summary>
    /// Indicates the "Bitmap embedding only" restriction.
    /// </summary>
    /// <remarks>
    /// When this bit is set, only bitmaps contained in the font may be embedded. No outline data may be embedded.
    /// If there are no bitmaps available in the font, then the font is considered unembeddable and the embedding
    /// services will fail. Other embedding restrictions also apply.
    /// </remarks>
    public bool BitmapEmbeddingOnly { get; }
}

/// <summary>
/// Represents the font embedding usage permissions.
/// </summary>
public enum FontEmbeddingUsagePermissions
{
    /// <summary>
    /// The font may be embedded, and may be permanently installed for use on a remote systems, or for use by
    /// other users.
    /// </summary>
    Installable,
    /// <summary>
    /// The font must not be modified, embedded or exchanged in any manner without first obtaining explicit
    /// permission of the legal owner.
    /// </summary>
    RestrictedLicense,
    /// <summary>
    /// The font may be embedded, and may be temporarily loaded on other systems for purposes of viewing or
    /// printing the document.
    /// </summary>
    /// <remarks>
    /// Documents containing Preview & Print fonts must be opened “read-only”; no edits may
    /// be applied to the document.
    /// </remarks>
    PrintAndPreview,
    /// <summary>
    /// The font may be embedded, and may be temporarily loaded on other systems.
    /// </summary>
    /// <remarks>
    /// As with Preview & Print embedding, documents containing Editable fonts may be opened for reading.
    /// In addition, editing is permitted, including ability to format new text using the embedded font, and
    /// changes may be saved.
    /// </remarks>
    Editable
}

public class FontInfo
{
    /// <summary>
    /// Gets the embedded font licensing rights.
    /// </summary>
    /// <remarks>
    /// <para>The value may be null if font is not embedded.</para>
    /// </remarks>
    public FontEmbeddingLicensingRights EmbeddingLicensingRights { get; }
}

public class PhysicalFontInfo
{
    /// <summary>
    /// Embedding licensing rights for the font.
    /// </summary>
    public FontEmbeddingLicensingRights EmbeddingLicensingRights { get; }
}

/// <summary>
/// Clears the headers and footers of this section.
/// </summary>
/// <remarks>
/// <p>The text of all headers and footers is cleared, but <see cref="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>
/// <param name="preserveWatermarks">True if the watermarks shall not be removed.</param>
public void ClearHeadersFooters(bool preserveWatermarks)

/// <summary>
/// Specifies whether backslash characters should be replaced with yen signs.
/// Default value is <c>false</c>.
/// </summary>
/// <remarks>
/// By default, Aspose.Words mimics MS Word's behavior and doesn't replace backslash characters with yen signs in
/// generated HTML documents. However, previous versions of Aspose.Words performed such replacements in certain
/// scenarios. This flag enables backward compatibility with previous versions of Aspose.Words.
/// </remarks>
public bool ReplaceBackslashWithYenSign { get; set; }
/// <summary>
/// Specifies whether backslash characters should be replaced with yen signs.
/// Default value is <c>false</c>.
/// </summary>
/// <remarks>
/// By default, Aspose.Words mimics MS Word's behavior and doesn't replace backslash characters with yen signs in
/// generated XAML documents. However, previous versions of Aspose.Words performed such replacements in certain
/// scenarios. This flag enables backward compatibility with previous versions of Aspose.Words.
/// </remarks>
public bool ReplaceBackslashWithYenSign { get; set; }

/// <summary>
/// Specifies whether to use SDT control Tag or Id property as a name of form field in PDF.
/// </summary>
/// <remarks>
/// <p>The default value is <c>false</c>.</p>
/// <para>When set to <c>false</c>, SDT control Id property is used as a name of form field in PDF.</para>
/// <para>When set to <c>true</c>, SDT control Tag property is used as a name of form field in PDF.</para>
/// <para>If set to <c>true</c> and Tag is empty, Id property will be used as a form field name.</para>
/// <para>If set to <c>true</c> and Tag values are not unique, duplicate Tag values will be altered to build
/// unique PDF form field names.</para>
/// </remarks>
public bool UseSdtTagAsFormFieldName
{
    get { return mUseSdtTagAsFormFieldName; }
    set { mUseSdtTagAsFormFieldName = value; }
}

/// <summary>
/// Converts the given input document into the output document using specified input output file names and its extensions.
/// </summary>
/// <param name="inputFile">The input file name.</param>
/// <param name="outputFile">The output file name.</param>
public static void Convert(string inputFile, string outputFile)

/// <summary>
/// Converts the given input document into the output document using specified input output file names and the final document format.
/// </summary>
/// <param name="inputFile">The input file name.</param>
/// <param name="outputFile">The output file name.</param>
/// <param name="saveFormat">The save format.</param>
public static void Convert(string inputFile, string outputFile, SaveFormat saveFormat)

/// <summary>
/// Converts the given input document into the output document using specified input output file names and save options.
/// </summary>
/// <param name="inputFile">The input file name.</param>
/// <param name="outputFile">The output file name.</param>
/// <param name="saveOptions">The save options.</param>
public static void Convert(string inputFile, string outputFile, SaveOptions saveOptions)

/// <summary>
/// Converts the given input document into a single output document using specified input and output streams.
/// </summary>
/// <param name="inputStream">The input stream.</param>
/// <param name="outputStream">The output stream.</param>
/// <param name="saveFormat">The save format.</param>
public static void Convert(Stream inputStream, Stream outputStream, SaveFormat saveFormat)

/// <summary>
/// Converts the given input document into a single output document using specified input and output streams.
/// </summary>
/// <param name="inputStream">The input streams.</param>
/// <param name="outputStream">The output stream.</param>
/// <param name="saveOptions">The save options.</param>
public static void Convert(Stream inputStream, Stream outputStream, SaveOptions saveOptions)

/// <summary>
/// Converts the input file pages to images.
/// </summary>
/// <param name="inputFile">The input file name.</param>
/// <param name="outputFile">The output file name used to generate file name for page images using rule "outputFile_pageIndex.extension"</param>
public static void ConvertToImages(string inputFile, string outputFile)

/// <summary>
/// Converts the input file pages to images.
/// </summary>
/// <param name="inputFile">The input file name.</param>
/// <param name="outputFile">The output file name used to generate file name for page images using rule "outputFile_pageIndex.extension"</param>
/// <param name="saveFormat">Save format. Only image save formats are allowed.</param>
public static void ConvertToImages(string inputFile, string outputFile, SaveFormat saveFormat)

/// <summary>
/// Converts the input file pages to images.
/// </summary>
/// <param name="inputFile">The input file name.</param>
/// <param name="outputFile">The output file name used to generate file name for page images using rule "outputFile_pageIndex.extension"</param>
/// <param name="saveOptions">Image save options.</param>
public static void ConvertToImages(string inputFile, string outputFile, ImageSaveOptions saveOptions)

/// <summary>
/// Converts the input file pages to images.
/// </summary>
/// <param name="inputFile">The input file name.</param>
/// <param name="saveFormat">Save format. Only image save formats are allowed.</param>
/// <returns>Returns array of image streams. The streams should be disposed by the enduser.</returns>
public static Stream[] ConvertToImages(string inputFile, SaveFormat saveFormat)

/// <summary>
/// Converts the input file pages to images.
/// </summary>
/// <param name="inputFile">The input file name.</param>
/// <param name="saveOptions">Image save options.</param>
/// <returns>Returns array of image streams. The streams should be disposed by the enduser.</returns>
public static Stream[] ConvertToImages(string inputFile, ImageSaveOptions saveOptions)

/// <summary>
/// Converts the input stream pages to images.
/// </summary>
/// <param name="inputStream">The input stream.</param>
/// <param name="saveFormat">Save format. Only image save formats are allowed.</param>
/// <returns>Returns array of image streams. The streams should be disposed by the enduser.</returns>
public static Stream[] ConvertToImages(Stream inputStream, SaveFormat saveFormat)

/// <summary>
/// Converts the input stream pages to images.
/// </summary>
/// <param name="inputStream">The input stream.</param>
/// <param name="saveOptions">Image save options.</param>
/// <returns>Returns array of image streams. The streams should be disposed by the enduser.</returns>
public static Stream[] ConvertToImages(Stream inputStream, ImageSaveOptions saveOptions)

/// <summary>
/// Converts the document pages to images.
/// </summary>
/// <param name="doc">The input document.</param>
/// <param name="saveFormat">Save format. Only image save formats are allowed.</param>
/// <returns>Returns array of image streams. The streams should be disposed by the enduser.</returns>
public static Stream[] ConvertToImages(Document doc, SaveFormat saveFormat)

/// <summary>
/// Converts the document pages to images.
/// </summary>
/// <param name="doc">The input document.</param>
/// <param name="saveOptions">Image save options.</param>
/// <returns>Returns array of image streams. The streams should be disposed by the enduser.</returns>
public static Stream[] ConvertToImages(Document doc, ImageSaveOptions saveOptions)

/// <summary>
/// Gets or sets <see cref="Aspose.Words.Saving.DigitalSignatureDetails"/> object used to sign a document.
/// </summary>
public DigitalSignatureDetails DigitalSignatureDetails { get; set; }