Files
QWERTYkez.OpenXmlProcessors/QWERTYkez.WordProcessor/ReplaceItem.cs
T
2026-07-23 16:42:26 +07:00

70 lines
3.3 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
namespace QWERTYkez.WordProcessor;
/// <summary>
/// Определяет тип разрыва или смены ориентации страницы, применяется к элементам следующим после замены
/// </summary>
public enum PageBreakType
{
/// <summary>Без разрыва или смены ориентации.</summary>
None,
/// <summary>Обычный разрыв страницы (новый лист).</summary>
PageBreak,
/// <summary>Начать новую секцию с альбомной ориентацией страницы.</summary>
NewLandscapeSection,
/// <summary>Начать новую секцию с книжной ориентацией страницы.</summary>
NewPortraitSection,
}
/// <summary>
/// Представляет элемент замены текста, содержащий сам текст и указание
/// на тип разрыва или смены ориентации, который должен быть применён
/// после вставки этого текста.
/// </summary>
/// <remarks>
/// Используется в методах множественной замены, например,
/// <see cref="IWordWriter.ReplaceItem(string, IEnumerable{ReplaceItem})"/>.
/// </remarks>
public readonly struct ReplaceItem
{
/// <summary>
/// Инициализирует новый экземпляр <see cref="ReplaceItem"/> с пустым текстом
/// и типом разрыва <see cref="PageBreakType.None"/>.
/// </summary>
public ReplaceItem() { }
/// <summary>
/// Инициализирует новый экземпляр <see cref="ReplaceItem"/> с указанным текстом
/// и типом разрыва/смены ориентации.
/// </summary>
/// <param name="text">Текст, который будет вставлен вместо плейсхолдера.</param>
/// <param name="splitValue">
/// Тип разрыва или смены ориентации, который будет применён после вставки текста.
/// По умолчанию <see cref="PageBreakType.None"/>.
/// </param>
public ReplaceItem(string text, PageBreakType splitValue = PageBreakType.None)
{
Text = text;
SplitValue = splitValue;
}
/// <summary>
/// Получает текст, который будет вставлен вместо плейсхолдера.
/// </summary>
public string Text { get; init; } = string.Empty;
/// <summary>
/// Получает тип разрыва или смены ориентации, который будет применён
/// после вставки текста.
/// </summary>
public PageBreakType SplitValue { get; init; } = PageBreakType.None;
/// <summary>
/// Определяет явное преобразование из строки в <see cref="ReplaceItem"/>.
/// </summary>
/// <param name="text">Строка текста.</param>
/// <returns>Новый экземпляр <see cref="ReplaceItem"/> с указанным текстом и <see cref="PageBreakType.None"/>.</returns>
public static explicit operator ReplaceItem(string text) => new() { Text = text };
}