API Reference
RtfImage
RTF picture payload preserved without external imaging dependencies.
Inheritance
- Object
- RtfImage
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
- Method RtfDocument.AddImage
- Method RtfDocument.InsertImage
- Property RtfObject.ResultImage
- Method RtfParagraph.AddImage
- Method RtfSection.AddImage
Accepted by parameters
Constructors
public RtfImage(RtfImageFormat format, Byte[] data) #Creates an image block.
Parameters
- format OfficeIMO.Rtf.RtfImageFormat
- data System.Byte[]
Methods
public RtfImageLayout ResolveLayout(Nullable<Double> fallbackWidthTwips = null, Nullable<Double> fallbackHeightTwips = null) #RtfImageLayoutResolves the picture's unscaled and visible sizes in twips. Pixel sizes use 96 DPI when no goal size is supplied.
Parameters
- fallbackWidthTwips System.Nullable{System.Double} = null
- fallbackHeightTwips System.Nullable{System.Double} = null
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public RtfImageFormat Format { get; set; } #Image format.
public Nullable<Int32> SourceWidth { get; set; } #Original width in pixels when present.
public Nullable<Int32> SourceHeight { get; set; } #Original height in pixels when present.
public Nullable<Int32> DesiredWidthTwips { get; set; } #Desired width in twips when present.
public Nullable<Int32> DesiredHeightTwips { get; set; } #Desired height in twips when present.
public Nullable<Int32> ScaleXPercent { get; set; } #Horizontal picture scale as a percentage. An omitted value means 100.
public Nullable<Int32> ScaleYPercent { get; set; } #Vertical picture scale as a percentage. An omitted value means 100.
public Nullable<Int32> CropLeftTwips { get; set; } #Unscaled twips cropped from the left edge. Negative values add space.
public Nullable<Int32> CropTopTwips { get; set; } #Unscaled twips cropped from the top edge. Negative values add space.
public Nullable<Int32> CropRightTwips { get; set; } #Unscaled twips cropped from the right edge. Negative values add space.
public Nullable<Int32> CropBottomTwips { get; set; } #Unscaled twips cropped from the bottom edge. Negative values add space.
public String Description { get; set; } #Alternative text or description.