RtfLoadOptions

RtfLoadOptions class

Allows to specify additional options when loading Rtf document into a Document object.

To learn more, visit the Specify Load Options documentation article.

public class RtfLoadOptions : LoadOptions

Constructors

Name	Description
RtfLoadOptions()	Initializes a new instance of this class with default values.

Properties

Name	Description
BaseUri { get; set; }	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`.
ConvertMetafilesToPng { get; set; }	Gets or sets whether to convert metafile(Wmf or Emf) images to Png image format.
ConvertShapeToOfficeMath { get; set; }	Gets or sets whether to convert shapes with EquationXML to Office Math objects.
Encoding { get; set; }	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`.
FontSettings { get; set; }	Allows to specify document font settings.
IgnoreOleData { get; set; }	Specifies whether to ignore the OLE data.
LanguagePreferences { get; }	Gets language preferences that will be used when document is loading.
LoadFormat { get; set; }	Specifies the format of the document to be loaded. Default is Auto.
MswVersion { get; set; }	Allows to specify that the document loading process should match a specific MS Word version. Default value is Word2019
Password { get; set; }	Gets or sets the password for opening an encrypted document. Can be `null` or empty string. Default is `null`.
PreserveIncludePictureField { get; set; }	Gets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats. The default value is `false`.
ProgressCallback { get; set; }	Called during loading a document and accepts data about loading progress.
RecognizeUtf8Text { get; set; }	When set to `true`, will try to detect UTF8 characters, they will be preserved during import.
ResourceLoadingCallback { get; set; }	Allows to control how external resources (images, style sheets) are loaded when a document is imported from HTML, MHTML.
TempFolder { get; set; }	Allows to use temporary files when reading document. By default this property is `null` and no temporary files are used.
UpdateDirtyFields { get; set; }	Specifies whether to update the fields with the `dirty` attribute.
UseSystemLcid { get; set; }	Gets or sets whether to use LCID value obtained from Windows registry to determine page setup default margins.
WarningCallback { get; set; }	Called during a load operation, when an issue is detected that might result in data or formatting fidelity loss.

Methods

Name	Description
override Equals(object)	Determines whether the specified object is equal in value to the current object.

Examples

Shows how to detect UTF-8 characters while loading an RTF document.

// Create an "RtfLoadOptions" object to modify how we load an RTF document.
RtfLoadOptions loadOptions = new RtfLoadOptions();

// Set the "RecognizeUtf8Text" property to "false" to assume that the document uses the ISO 8859-1 charset
// and loads every character in the document.
// Set the "RecognizeUtf8Text" property to "true" to parse any variable-length characters that may occur in the text.
loadOptions.RecognizeUtf8Text = recognizeUtf8Text;

Document doc = new Document(MyDir + "UTF-8 characters.rtf", loadOptions);

Assert.AreEqual(
    recognizeUtf8Text
        ? "“John Doe´s list of currency symbols”™\r" +
          "€, ¢, £, ¥, ¤"
        : "â€œJohn DoeÂ´s list of currency symbolsâ€\u009dâ„¢\r" +
          "â‚¬, Â¢, Â£, Â¥, Â¤",
    doc.FirstSection.Body.GetText().Trim());