Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

PublisherTextFrame

OfficeIMO.Publisher

Namespace
OfficeIMO.Publisher
Assembly
OfficeIMO.Publisher
Source revision
0eef6a5756b9 with working tree changes
Modifiers
sealed

A current publication text-frame snapshot, imported or authored. Assigned text ranges use OfficeIMO's managed layout and can differ from Publisher.

Inheritance

  • object
  • PublisherTextFrame

Usage

Explore 3 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.

Properties

public uint Id { get; } #

Stable publication object identifier, scoped to this document.

public uint StoryId { get; } #

Identifier of the complete current story in PublisherDocument.TextStories.

public uint PageId { get; } #

Owning document or master page identifier.

public uint? PreviousFrameId { get; } #

Previous current frame, or null for the first frame.

public uint? NextFrameId { get; } #

Next current frame, or null for the last frame.

public uint Order { get; } #

Zero-based current order within the linked story.

public double X { get; } #

Left edge in page-local points, before object and enclosing-group rotation or reflection.

public double Y { get; } #

Top edge in page-local points, before object and enclosing-group rotation or reflection.

public double Width { get; } #

Frame width in points.

public double Height { get; } #

Frame height in points.

public OfficeTransform PageTransform { get; } #

Maps frame-local points into page-local points, including object and enclosing-group rotation/reflection.

public int ColumnCount { get; } #

Number of equal-width text columns.

public double ColumnSpacing { get; } #

Gap between text columns in points.

public OfficeTextPadding Padding { get; } #

Current text insets in points, applied before column layout.

public OfficeTextVerticalAlignment VerticalAlignment { get; } #

Current Core vertical alignment within each generated text region.

public bool CanEditLayout { get; } #

Whether SetTextFrameLayout can change this resolved non-table frame's layout. The requested content area is validated separately.

public string? LayoutEditLimitation { get; } #

Reason layout editing is unavailable, or null when this frame is eligible. Reading and bounds eligibility are separate contracts.

public IReadOnlyList<uint> WrapObjectIds { get; } #

Native objects referenced by this frame's text-wrap exclusion list.

public int? TextStart { get; } #

UTF-16 start in the normalized current story, or null when placement is unresolved.

public int? TextLength { get; } #

Assigned UTF-16 length, including paragraph separators; null when placement is unresolved.

public bool HasOverflow { get; } #

Whether story content remains after the final current frame.