CreateLayoutOptions

页面版面、分页、Form XObject

描述

为 TPDFlibDynamicLayoutOptions 构建一个字段完整的 ComposeNextLayout 记录,其默认值与普通 ComposeNext 的行为一致

语法

Class Function TPDFlibDynamicComponentSession.CreateLayoutOptions(
  ContentWidth, ContentHeight: Double;
  OverflowPolicy: TPDFlibDynamicOverflowPolicy = dopReject;
  HorizontalAlignment: TPDFlibDynamicHorizontalAlignment = dhaLeft;
  VerticalAlignment: TPDFlibDynamicVerticalAlignment = dvaTop;
  PaginationPolicy: TPDFlibDynamicPaginationPolicy = dppAllowSplit;
  MinimumSlotHeight: Double = 0;
  MinimumFollowingHeight: Double = 0):
  TPDFlibDynamicLayoutOptions; Static;

参数

ContentWidth, ContentHeight有限的正数自然画布,会通过 AvailableWidth 和 AvailableHeight 传递给组件
OverflowPolicydopReject、dopClip 或 dopScaleDown
HorizontalAlignmentdhaLeft、dhaCenter 或 dhaRight
VerticalAlignmentdvaTop、dvaCenter 或 dvaBottom
PaginationPolicydppAllowSplit、dppKeepTogether 或 dppRequireComplete
MinimumSlotHeight组件克隆与合成开始之前所需的非负槽位高度
MinimumFollowingHeight在最终确定的片段之后为后续组件保留的非负高度

备注

辅助函数只是从参数为每个记录字段赋值,自身不做校验;ComposeNextLayout 会在任何组件工作开始前检查有限性、正号和枚举范围

作为静态类函数,无需会话实例即可调用

ComposeNext 从 CreateLayoutOptions(Width, Height) 推导默认选项

示例

Options := TPDFlibDynamicComponentSession.CreateLayoutOptions(
  640, 360, dopScaleDown, dhaLeft, dvaTop, dppAllowSplit, 72, 24);

Status := Session.ComposeNextLayout(
  PageNumber, 36, 72, 540, 240, Options, Placement);

返回值

TPDFlibDynamicLayoutOptions已按传入的自然画布、溢出、对齐、分页和流式空间设置填充完毕的记录,可直接用于 ComposeNextLayout

另请参阅

ComposeNextLayout, ComposeNext, TPDFlibDynamicComponentSession, KeepTogetherRetryPending, LastRetryReason