CreateLayoutOptions

Верстка страниц, разбивка на страницы, Form XObjects

Описание

Создает полностью заполненную запись 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