Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

RtfObject

OfficeIMO.Rtf

Namespace
OfficeIMO.Rtf
Assembly
OfficeIMO.Rtf
Source revision
ba882f6b0d07 with working tree changes
Implements
IRtfCloneable IRtfInline IRtfBlock
Modifiers
sealed

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

Inheritance

  • object
  • RtfObject

Usage

Explore 2 API references to this type

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

Returned or exposed by 2

Constructors

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

Creates an RTF object with optional raw object payload.

Parameters

kind OfficeIMO.Rtf.RtfObjectKind = Unknown optional
data byte[]? = null optional

Methods

public string ToPlainText() #

Returns the fallback result as plain text.

Returns

string

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 long PayloadLength { get; } #

Available decoded byte length without materializing a deferred source payload.

public int? Width { get; set; } #

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

public int? Height { get; set; } #

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

public int? ScaleX { get; set; } #

Horizontal scale percentage when declared by \objscalex.

public int? ScaleY { get; set; } #

Vertical scale percentage when declared by \objscaley.

public RtfParagraph Result { get; private 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.