Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

RtfObject

Namespace OfficeIMO.Rtf
Assembly OfficeIMO.Rtf
Implements
IRtfCloneable IRtfInline IRtfBlock
Modifiers sealed

Dependency-free representation of an RTF embedded or linked object.

Inheritance

  • Object
  • RtfObject

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Constructors

public RtfObject(RtfObjectKind kind = Unknown, Byte[] data = null) #

Creates an RTF object with optional raw object payload.

Parameters

kind OfficeIMO.Rtf.RtfObjectKind = Unknown optionalposition: 0
data System.Byte[] = null optionalposition: 1

Methods

public String ToPlainText() #
Returns: String

Returns the fallback result as plain text.

Properties

public RtfObjectKind Kind { get; set; } #

Object embedding or linking kind.

public String ClassName { get; set; } #

Object class text from \objclass when present.

public String Name { get; set; } #

Object name text from \objname when present.

public Byte[] Data { get; set; } #

Raw bytes from the \objdata destination.

public Nullable<Int32> Width { get; set; } #

Object source width in twips or object units when declared by \objw.

public Nullable<Int32> Height { get; set; } #

Object source height in twips or object units when declared by \objh.

public Nullable<Int32> ScaleX { get; set; } #

Horizontal scale percentage when declared by \objscalex.

public Nullable<Int32> ScaleY { get; set; } #

Vertical scale percentage when declared by \objscaley.

public RtfParagraph Result { get; set; } #

Textual/rich fallback result shown by readers that cannot activate the object.

public RtfImage ResultImage { get; set; } #

Picture fallback result when the object declares a result picture.