API Reference
OfficeRasterTextOptions
Shared font, layout and effect settings for raster text measurement and drawing.
Inheritance
- Object
- OfficeRasterTextOptions
Remarks
Operations snapshot scalar settings and the font collection. Font and shaping providers, and the optional diagnostic sink, are retained references. Drawing mutates pixels and cancellation does not undo pixels already painted.
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
Accepted by parameters
- Method OfficeRasterText.Draw
- Method OfficeRasterText.EstimateAdditionalWorkingBytes
- Method OfficeRasterText.Measure
Constructors
public OfficeRasterTextOptions() #Methods
public OfficeRasterTextOptions Clone() #OfficeRasterTextOptionsReturns an independent copy of the settings and scoped font collection for a composed operation.
Inherited Methods
Properties
public Double FontSize { get; set; } #Positive finite text size in pixels.
public String FontFamily { get; set; } #Requested managed font family or fallback list.
public OfficeFontStyle FontStyle { get; set; } #Existing bold, italic, underline and strikethrough style flags.
public OfficeTrueTypeFont Font { get; set; } #Explicit outline font; null uses the canvas default font.
public OfficeFontFaceCollection Fonts { get; set; } #Scoped managed font faces used consistently for measurement and drawing.
public IOfficeTextShapingProvider TextShapingProvider { get; set; } #Optional shaping provider supported by the shared canvas.
public String TextShapingLanguage { get; set; } #Optional language passed to the shaping provider.
public ICollection<OfficeImageExportDiagnostic> DiagnosticSink { get; set; } #Optional collection receiving canvas fidelity diagnostics.
public String DiagnosticSource { get; set; } #Optional source identifier attached to diagnostics.
public OfficeTextAlignment HorizontalAlignment { get; set; } #Horizontal alignment in the drawing rectangle.
public OfficeTextVerticalAlignment VerticalAlignment { get; set; } #Vertical alignment in the drawing rectangle.
public Double LineHeight { get; set; } #Positive finite multiplier of font size used for line height.
public Boolean Wrap { get; set; } #Wraps to the drawing width or the explicitly supplied measurement width.
public Boolean Clip { get; set; } #Clips glyphs, outline and shadow to the drawing rectangle.
public Nullable<OfficeColor> ShadowColor { get; set; } #Optional shadow color.
public Double ShadowOffsetX { get; set; } #Finite horizontal shadow offset in pixels, rounded to the nearest pixel.
public Double ShadowOffsetY { get; set; } #Finite vertical shadow offset in pixels, rounded to the nearest pixel.
public Nullable<OfficeColor> OutlineColor { get; set; } #Optional outline color.
public Double OutlineWidth { get; set; } #Rounded coverage-expansion radius from zero through sixty-four pixels.