Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OfficeTextParagraphLabel

Namespace OfficeIMO.Drawing
Assembly OfficeIMO.Core
Modifiers sealed

A styled list label placed independently of the paragraph's wrapped text.

Inheritance

  • Object
  • OfficeTextParagraphLabel

Remarks

Render-time layout omits an entire label that exceeds the content rectangle's right edge or right margin, marks the layout as clipped, and preserves the logical text and body insets.

Usage

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

Accepted by parameters

Methods

public static OfficeTextParagraphLabel AtPosition(OfficeRichTextRun run, Double position, OfficeTextAlignment alignment = Left, OfficeTextParagraphLabelFollowedBy followedBy = Position, Nullable<Double> textPosition = null) #
Returns: OfficeTextParagraphLabel

Aligns a label at an absolute position inside the text frame's content rectangle.

Parameters

run OfficeIMO.Drawing.OfficeRichTextRun requiredposition: 0
The independently styled label.
position System.Double requiredposition: 1
Left edge, center or right edge according to alignment.
alignment OfficeIMO.Drawing.OfficeTextAlignment = Left optionalposition: 2
Label alignment at the position.
followedBy OfficeIMO.Drawing.OfficeTextParagraphLabelFollowedBy = Position optionalposition: 3
Whether text uses a declared position, a space or no separator.
textPosition System.Nullable{System.Double} = null optionalposition: 4
Optional first-line text position for Position mode.
public static OfficeTextParagraphLabel InBox(OfficeRichTextRun run, Double position, Double minimumWidth, OfficeTextAlignment alignment = Left, Double minimumDistance = 0) #
Returns: OfficeTextParagraphLabel

Places a label inside a minimum-width box. A wider label expands the box.

Parameters

run OfficeIMO.Drawing.OfficeRichTextRun requiredposition: 0
position System.Double requiredposition: 1
minimumWidth System.Double requiredposition: 2
alignment OfficeIMO.Drawing.OfficeTextAlignment = Left optionalposition: 3
minimumDistance System.Double = 0 optionalposition: 4

Properties

public OfficeRichTextRun Run { get; } #

Snapshot of the label's styled text.

public Double Position { get; } #

Position relative to the frame's content rectangle, before scaling.

public OfficeTextAlignment Alignment { get; } #

Alignment inside the box or at the anchor.

public Nullable<Double> MinimumWidth { get; } #

Minimum label box width, or null for point alignment.

public Double MinimumDistance { get; } #

Minimum distance between the label and the first text line.

public OfficeTextParagraphLabelFollowedBy FollowedBy { get; } #

How the first text line follows the label.

public Nullable<Double> TextPosition { get; } #

Optional first-line text position, independent of continuation indentation.