PageLayoutEvent

PageLayoutEvent enumeration

Код события, возникающий во время построения и рендеринга модели макета страницы.

Модель макета страницы строится в два этапа. Первый «шаг преобразования», когда макет страницы извлекает содержимое документа и создает граф объекта. Второй, «этап перекомпоновки», это когда структуры разделяются, объединяются и упорядочиваются. на страницы.

В зависимости от операции, вызвавшей сборку, модель макета страницы может быть или не быть преобразована в фиксированный формат страницы. Например, вычисление количества страниц в документе или обновление полей не требует визуализации, тогда как экспорт в PDF требует.

public enum PageLayoutEvent

Ценности

ИмяЦенностьОписание
None0Значение по умолчанию
WatchDog1Соответствует контрольной точке в коде, которая часто посещается и подходит для прерывания процесса.
BuildStarted2Началась сборка макета страницы. Вызывается один раз. Это первое событие, которое происходит, когдаUpdatePageLayout называется.
BuildFinished3Создание макета страницы завершено. Вызывается один раз. Это последнее событие, которое происходит, когдаUpdatePageLayout называется.
ConversionStarted4Преобразование модели документа в макет страницы началось. Запускается один раз. Это происходит, когда модель макета начинает извлекать содержимое документа.
ConversionFinished5Преобразование модели документа в макет страницы завершено. Запускается один раз. Это происходит, когда модель макета перестает извлекать содержимое документа.
ReflowStarted6Началась перекомпоновка макета страницы. Вызывается один раз. Это происходит, когда модель макета начинает перекомпоновывать содержимое документа.
ReflowFinished7Перекомпоновка макета страницы завершена. Вызывается один раз. Это происходит, когда модель макета перестает перекомпоновывать содержимое документа.
PartReflowStarted8Началась перекомпоновка страницы. Обратите внимание, что страница может перекомпоновываться несколько раз, и перекомпоновка может возобновиться до ее завершения.
PartReflowFinished9Перекомпоновка страницы завершена. Обратите внимание, что страница может перекомпоновываться несколько раз, и перекомпоновка может возобновиться до ее завершения.
PartRenderingStarted10Начался рендеринг страницы. Это запускается один раз на страницу.
PartRenderingFinished11Отрисовка страницы завершена. Это запускается один раз на страницу.

Примеры

Показывает, как отслеживать изменения макета с помощью обратного вызова макета.

public void PageLayoutCallback()
{
    Document doc = new Document();
    doc.BuiltInDocumentProperties.Title = "My Document";

    DocumentBuilder builder = new DocumentBuilder(doc);
    builder.Writeln("Hello world!");

    doc.LayoutOptions.Callback = new RenderPageLayoutCallback();
    doc.UpdatePageLayout();

    doc.Save(ArtifactsDir + "Layout.PageLayoutCallback.pdf");
}

/// <summary>
/// Уведомляет нас, когда мы сохраняем документ в фиксированном формате страницы
/// и отображает страницу, на которой мы выполняем перекомпоновку страницы, в изображение в локальной файловой системе.
/// </summary>
private class RenderPageLayoutCallback : IPageLayoutCallback
{
    public void Notify(PageLayoutCallbackArgs a)
    {
        switch (a.Event)
        {
            case PageLayoutEvent.PartReflowFinished:
                NotifyPartFinished(a);
                break;
            case PageLayoutEvent.ConversionFinished:
                NotifyConversionFinished(a);
                break;
        }
    }

    private void NotifyPartFinished(PageLayoutCallbackArgs a)
    {
        Console.WriteLine($"Part at page {a.PageIndex + 1} reflow.");
        RenderPage(a, a.PageIndex);
    }

    private void NotifyConversionFinished(PageLayoutCallbackArgs a)
    {
        Console.WriteLine($"Document \"{a.Document.BuiltInDocumentProperties.Title}\" converted to page format.");
    }

    private void RenderPage(PageLayoutCallbackArgs a, int pageIndex)
    {
        ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.Png) { PageSet = new PageSet(pageIndex) };

        using (FileStream stream =
            new FileStream(ArtifactsDir + $@"PageLayoutCallback.page-{pageIndex + 1} {++mNum}.png",
                FileMode.Create))
            a.Document.Save(stream, saveOptions);
    }

    private int mNum;
}

Смотрите также

PageLayoutCallbackArgs Class RevisionColor Enum