Изменения страницы XPS на основе событий | .NET

Что такое событийный подход в программировании?

Событийный подход в программировании — это парадигма, которая вращается вокруг концепции событий и их обработки. В этой модели ход выполнения программы определяется событиями, которыми могут быть действия пользователя (например, щелчки мыши или нажатия клавиш), генерируемые системой уведомления или сообщения от других приложений. Вот некоторые ключевые аспекты событийно-ориентированного подхода:

• События: События представляют собой важные события в программе. Они могут включать взаимодействие с пользователем, изменения в данных или сообщения из других частей системы. Например, нажатие кнопки или загрузка файла могут вызвать события.

• Прослушиватели событий. Чтобы реагировать на события, программисты используют прослушиватели событий (или обработчики). Это функции или методы, которые определены для выполнения при возникновении определенного события. Например, прослушиватель событий можно настроить на выполнение функции, когда пользователь нажимает кнопку.

• Асинхронное выполнение. Модель, основанная на событиях, часто поддерживает асинхронное программирование, позволяя программам оставаться отзывчивыми в ожидании возникновения событий. Например, веб-приложение может продолжать работать, ожидая данных с сервера.

• Развязка. Подход, основанный на событиях, способствует разделению различных частей программы. Компоненты могут взаимодействовать посредством событий, не зная деталей реализации друг друга, что делает код более модульным и простым в обслуживании.

• Распространенные случаи использования. Программирование, управляемое событиями, широко используется в графических интерфейсах пользователя (GUI), веб-приложениях и системах, требующих взаимодействия в реальном времени. Фреймворки и библиотеки, такие как Node.js, React и многие другие, используют шаблоны, управляемые событиями.

• Управление состоянием. В системе, управляемой событиями, управление состоянием может иметь решающее значение, поскольку приложение может находиться в разных состояниях в зависимости от действий пользователя или событий. Правильные стратегии управления состоянием часто используются для обеспечения ожидаемого поведения приложения.

В целом, подход на основе событий — это мощный способ управления взаимодействиями и рабочими процессами внутри программы, что делает его особенно эффективным для приложений, требующих оперативности и взаимодействия с пользователем.

События, происходящие во время преобразования документа XPS

Когда вам нужно внести изменения в определенную страницу документа XPS с помощью API Aspose.Page, вы обычно выбираете активный документ (если в файле XPS несколько документов), выбираете активную страницу, а затем сами вносите изменения. .

Теперь предположим, что вам нужно внести повторяющиеся изменения во все страницы файла XPS, а затем преобразовать результат в PDF или формат изображения. Некоторые примеры таких изменений включают размещение водяных знаков на страницах или добавление навигационных гиперссылок. Прямой способ внесения таких изменений включает в себя просмотр документов в пакете XPS, просмотр страниц текущего активного документа и, наконец, применение ваших изменений. Таким образом, код для выполнения этой задачи будет выглядеть следующим образом:

for (int i = 1; i <= document.DocumentCount; i++)
{
    document.SelectActiveDocument(i);
    for (j = 1; j <= document.PageCount; j++)
    {
        document.SelectActivePage(j);
        // Your changes ...
    }
}
document.SaveAsPdf("file-name.pdf", saveOptions);

Если вам также необходимо внести некоторые нерегулярные изменения перед повторяющимися, этот подход может привести к некоторой путанице или чрезмерному обходу документов и страниц, не говоря уже о том, что эти циклы могут показаться немного громоздкими. Когда вы конвертируете документ XPS в PDF или изображение, процесс происходит страница за страницей. Когда задание преобразования готово к обработке следующей страницы, оно вызывает событие «до страницы». Пользователь может определить обработку таких событий, расширив класс BeforePageSavingEventHandler, тем самым воспользовавшись некоторыми преимуществами, описанными во вводном разделе этой статьи.

Пример добавления навигационных гиперссылок

Здесь мы приведем пример, связанный с навигационными гиперссылками. А чтобы немного усложнить задачу, мы преобразуем в PDF только часть всех страниц, как указано в свойстве PdfSaveOptions.PageNumbers.

Класс обработчика событий

Ниже показано расширение класса BeforePageSavingEventHandler:

/// <summary>
/// The class to handle the before-page event while converting an XPS document.
/// </summary>
public class NavigationInjector : BeforePageSavingEventHandler
{
    // The font in which navigation hyperlinks and page numbers will be displayed.
    private readonly XpsFont _font;
    // The page numbers to convert.
    private readonly SortedList<int, int> _pageNumbers;

    public NavigationInjector(XpsFont font, int[] pageNumbers)
    {
        _font = font;
        if (pageNumbers == null)
            return;

        // Turn the page number array into a sorted collection of unique values.
        _pageNumbers = new SortedList<int, int>();
        foreach (int pn in pageNumbers)
            _pageNumbers[pn] = 0;
    }

    public override void Handle(BeforeSavingEventArgs<PageAPI> args)
    {
        PageAPI api = args.ElementAPI;

        XpsGlyphs glyphs;
        // For all pages in the output PDF except the first one...
        if (args.OutputPageNumber > 1)
        {
            // ...insert a hyperlink to the first page...
            glyphs = api.CreateGlyphs(_font, 15f, 5f, api.Height - 10f, "[First]");
            glyphs.Fill = api.CreateSolidColorBrush(Color.Blue);
            glyphs.HyperlinkTarget = new XpsPageLinkTarget(_pageNumbers == null ? 1 : _pageNumbers.Keys[0]);
            api.Add(glyphs);

            // ...and to the previous page.
            glyphs = api.CreateGlyphs(_font, 15f, 60f, api.Height - 10f, "[Prev]");
            glyphs.Fill = api.CreateSolidColorBrush(Color.Blue);
            glyphs.HyperlinkTarget = new XpsPageLinkTarget(
                _pageNumbers == null ? args.AbsolutePageNumber - 1 : _pageNumbers.Keys[args.OutputPageNumber - 2]);
            api.Add(glyphs);
        }

        // For all pages in the output PDF except the last one...
        if ((_pageNumbers != null && args.OutputPageNumber < _pageNumbers.Count) ||
            (_pageNumbers == null && args.OutputPageNumber < api.TotalPageCount))
        {
            // ...insert a hyperlink to the next page...
            glyphs = api.CreateGlyphs(_font, 15f, 110f, api.Height - 10f, "[Next]");
            glyphs.Fill = api.CreateSolidColorBrush(Color.Blue);
            glyphs.HyperlinkTarget = new XpsPageLinkTarget(
                _pageNumbers == null ? args.AbsolutePageNumber + 1 : _pageNumbers.Keys[args.OutputPageNumber]);
            api.Add(glyphs);

            // ...and to the last page.
            glyphs = api.CreateGlyphs(_font, 15f, 160f, api.Height - 10f, "[Last]");
            glyphs.Fill = api.CreateSolidColorBrush(Color.Blue);
            glyphs.HyperlinkTarget = new XpsPageLinkTarget(
                _pageNumbers == null ? api.TotalPageCount : _pageNumbers.Keys[_pageNumbers.Keys.Count - 1]);
            api.Add(glyphs);
        }

        // Insert a page number in the bottom-right corner.
        glyphs = api.CreateGlyphs(_font, 15f, api.Width - 20f, api.Height - 10f, args.OutputPageNumber.ToString());
        glyphs.Fill = api.CreateSolidColorBrush(Color.Black);
        api.Add(glyphs);

        // Add an outline entry to display the links to the converted pages in the navigation pane of a PDF viewer.
        api.AddOutlineEntry(string.Format("Page {0}", args.OutputPageNumber), 1, args.AbsolutePageNumber);
    }
}

Класс-обработчик должен знать, какие страницы мы хотим сохранить в формате PDF, чтобы создать правильные цели гиперссылок. Следовательно, конструктор должен принимать в качестве аргумента свойство массива параметров. Если указан массив номеров страниц, мы создаем их отсортированную коллекцию, избегая при этом дубликатов. (Кстати, это решение не совсем точное. Можете ли вы выяснить, что может вызвать несогласованность вывода?) Нам также понадобится объект XpsFont, содержащий данные шрифта для текста гиперссылки.

Все это происходит в переопределенном методе Handle(). Аргументом метода является объект, который содержит API модификации для текущей страницы, номер документа в пакете XPS, абсолютный номер страницы во всех документах, относительный номер страницы в текущем документе (который равен предыдущий номер, если в пакете только один документ) и номер выходной страницы (который равен абсолютному номеру страницы при конвертации всего пакета).

Логика следующих двух блоков if довольно проста. Он основан на анализе аргумента события OutputPageNumber для исключения некоторых ссылок, где это необходимо: ссылки [First] и [Prev] будут добавлены ко всем выходным страницам, кроме первой, а Ссылки [Следующий] и [Последний] появятся на всех страницах, кроме последней. Логика также адаптирована для обоих случаев, независимо от того, указаны номера страниц или нет.

После блоков if в правом нижнем углу страницы находится код для добавления номера страницы.

Последняя строка добавляет запись структуры страницы, элемент, который будет отображаться в панели навигации средства просмотра PDF (если поддерживается).

Код преобразования

Теперь, когда обработчик события «перед страницей» определен, мы можем написать код, преобразующий документ:

// The path to the documents directory.
string dataDir = RunExamples.GetDataDir_WorkingWithPages();
// Open an XPS document
using (XpsDocument doc = new XpsDocument(dataDir + "Sample3.xps"))
// Create a font
using (Stream fontStream = File.OpenRead(dataDir + "arialbd.ttf"))
{
    // Create options for conversion to PDF
    PdfSaveOptions options = new PdfSaveOptions();
    // Set the filter for the pages that need conversion
    options.PageNumbers = new int[] { 2, 6, 7, 13 };
    // Add the event handler that will execute right before the conversion of each page
    options.BeforePageSavingEventHandlers.Add(new NavigationInjector(doc.CreateFont(fontStream), options.PageNumbers));
    // Save resultant XPS document
    doc.SaveAsPdf(dataDir + "ModifyPageOnConversion_out.pdf", options);
}

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

Все, что осталось сделать, это запустить преобразование в PDF, используя метод SaveAsPdf() документа.

Заключение

В этой статье мы рассмотрели ключевые моменты событийно-ориентированного подхода в программировании, рассмотрели прямой метод изменения страниц документа XPS и изучили более продвинутый и сложный метод внесения повторяющихся изменений во все выходные страницы во время процесс преобразования на примере вставки навигационных гиперссылок.

Полные примеры можно найти в нашем Пример проекта.