DocumentBuilder

DocumentBuilder class

Предоставляет методы для вставки текста, изображений и другого содержимого, указания шрифта, форматирования абзаца и раздела.

public class DocumentBuilder

Конструкторы

Имя Описание
DocumentBuilder() Инициализирует новый экземпляр этого класса.
DocumentBuilder(Document) Инициализирует новый экземпляр этого класса.

Характеристики

Имя Описание
Bold { get; set; } Истинно, если шрифт отформатирован как полужирный.
CellFormat { get; } Возвращает объект, представляющий текущие свойства форматирования ячейки таблицы.
CurrentNode { get; } Получает узел, выбранный в данный момент в этом DocumentBuilder.
CurrentParagraph { get; } Получает абзац, выбранный в настоящий момент в этом DocumentBuilder.
CurrentSection { get; } Получает раздел, выбранный в данный момент в этом DocumentBuilder.
CurrentStory { get; } Получает историю, выбранную в данный момент в этом DocumentBuilder.
Document { get; set; } Получает или задаетDocument объект, к которому прикреплен этот объект.
Font { get; } Возвращает объект, представляющий текущие свойства форматирования шрифта.
IsAtEndOfParagraph { get; } Возвращает true, если курсор находится в конце текущего абзаца.
IsAtStartOfParagraph { get; } Возвращает true, если курсор находится в начале текущего абзаца (перед курсором нет текста).
Italic { get; set; } Истинно, если шрифт отформатирован как курсив.
ListFormat { get; } Возвращает объект, представляющий текущие свойства форматирования списка.
PageSetup { get; } Возвращает объект, представляющий текущую настройку страницы и свойства раздела.
ParagraphFormat { get; } Возвращает объект, представляющий текущие свойства форматирования абзаца.
RowFormat { get; } Возвращает объект, представляющий текущие свойства форматирования строки таблицы.
Underline { get; set; } Получает/устанавливает тип подчеркивания для текущего шрифта.

Методы

Имя Описание
DeleteRow(int, int) Удаляет строку из таблицы.
EndBookmark(string) Помечает текущую позицию в документе как конец закладки.
EndColumnBookmark(string) Помечает текущую позицию в документе как конец закладки столбца. Позиция должна быть в ячейке таблицы.
EndEditableRange() Помечает текущую позицию в документе как конец редактируемого диапазона.
EndEditableRange(EditableRangeStart) Помечает текущую позицию в документе как конец редактируемого диапазона.
EndRow() Завершает строку таблицы в документе.
EndTable() Завершает таблицу в документе.
InsertBreak(BreakType) Вставляет в документ разрыв указанного типа.
InsertCell() Вставляет ячейку таблицы в документ.
InsertChart(ChartType, double, double) Вставляет объект диаграммы в документ и масштабирует его до указанного размера.
InsertChart(ChartType, RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType) Вставляет объект диаграммы в документ и масштабирует его до указанного размера.
InsertCheckBox(string, bool, int) Вставляет поле формы флажка в текущую позицию.
InsertCheckBox(string, bool, bool, int) Вставляет поле формы флажка в текущую позицию.
InsertComboBox(string, string[], int) Вставляет поле формы со списком в текущую позицию.
InsertDocument(Document, ImportFormatMode) Вставляет документ в позицию курсора.
InsertDocument(Document, ImportFormatMode, ImportFormatOptions) Вставляет документ в позицию курсора.
InsertField(string) Вставляет поле Word в документ и обновляет результат поля.
InsertField(FieldType, bool) Вставляет поле Word в документ и при необходимости обновляет результат поля.
InsertField(string, string) Вставляет поле Word в документ без обновления результата поля.
InsertFootnote(FootnoteType, string) Вставляет сноску или концевую сноску в документ.
InsertFootnote(FootnoteType, string, string) Вставляет сноску или концевую сноску в документ.
InsertHorizontalRule() Вставляет в документ форму горизонтальной линейки.
InsertHtml(string) Вставляет строку HTML в документ.
InsertHtml(string, bool) Вставляет строку HTML в документ.
InsertHtml(string, HtmlInsertOptions) Вставляет строку HTML в документ. Позволяет указать дополнительные параметры.
InsertHyperlink(string, string, bool) Вставляет гиперссылку в документ.
InsertImage(byte[]) Вставляет изображение из байтового массива в документ. Изображение вставляется в строку и в масштабе 100%.
InsertImage(Image) Вставляет изображение из .NETImage в документ. Изображение вставляется в строку и в масштабе 100%.
InsertImage(Stream) Вставляет изображение из потока в документ. Изображение вставляется в строку и в масштабе 100%.
InsertImage(string) Вставляет изображение из файла или URL-адреса в документ. Изображение вставляется в строку и в масштабе 100%.
InsertImage(byte[], double, double) Вставляет встроенное изображение из массива байтов в документ и масштабирует его до указанного размера.
InsertImage(Image, double, double) Вставляет встроенное изображение из .NETImage объект в документ и масштабирует его до указанного размера.
InsertImage(Stream, double, double) Вставляет встроенное изображение из потока в документ и масштабирует его до указанного размера.
InsertImage(string, double, double) Вставляет встроенное изображение из файла или URL-адреса в документ и масштабирует его до указанного размера.
InsertImage(byte[], RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType) Вставляет изображение из массива байтов в указанной позиции и размере.
InsertImage(Image, RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType) Вставляет изображение из .NETImage объект в указанной позиции и размере.
InsertImage(Stream, RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType) Вставляет изображение из потока в указанной позиции и размере.
InsertImage(string, RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType) Вставляет изображение из файла или URL-адреса в указанной позиции и размере.
InsertNode(Node) Вставляет узел текстового уровня внутри текущего абзаца перед курсором.
InsertOleObject(Stream, string, bool, Stream) Вставляет встроенный объект OLE из потока в документ.
InsertOleObject(string, bool, bool, Stream) Вставляет встроенный или связанный объект OLE из файла в документ. Определяет тип объекта OLE, используя расширение файла.
InsertOleObject(string, string, bool, bool, Stream) Вставляет встроенный или связанный объект OLE из файла в документ. Определяет тип объекта OLE, используя заданный параметр progID.
InsertOleObjectAsIcon(Stream, string, string, string) Вставляет встроенный объект OLE в виде значка из потока в документ. Позволяет указать файл значка и заголовок. Определяет тип объекта OLE, используя заданный параметр progID.
InsertOleObjectAsIcon(string, bool, string, string) Вставляет встроенный или связанный объект OLE в качестве значка в документ. Позволяет указать файл значка и заголовок. Определяет тип объекта OLE, используя расширение файла.
InsertOleObjectAsIcon(string, string, bool, string, string) Вставляет встроенный или связанный объект OLE в качестве значка в документ. Позволяет указать файл значка и заголовок. Определяет тип объекта OLE, используя заданный параметр progID.
InsertOnlineVideo(string, double, double) Вставляет объект онлайн-видео в документ и масштабирует его до указанного размера.
InsertOnlineVideo(string, string, byte[], double, double) Вставляет объект онлайн-видео в документ и масштабирует его до указанного размера.
InsertOnlineVideo(string, RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType) Вставляет объект онлайн-видео в документ и масштабирует его до указанного размера.
InsertOnlineVideo(string, string, byte[], RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType) Вставляет объект онлайн-видео в документ и масштабирует его до указанного размера.
InsertParagraph() Вставляет разрыв абзаца в документ.
InsertShape(ShapeType, double, double) Вставляет встроенную фигуру указанного типа и размера.
InsertShape(ShapeType, RelativeHorizontalPosition, double, RelativeVerticalPosition, double, double, double, WrapType) Вставляет свободно плавающую фигуру с указанным положением, размером и типом обтекания текстом.
InsertSignatureLine(SignatureLineOptions) Вставляет строку подписи в текущую позицию.
InsertSignatureLine(SignatureLineOptions, RelativeHorizontalPosition, double, RelativeVerticalPosition, double, WrapType) Вставляет строку подписи в указанную позицию.
InsertStyleSeparator() Вставляет разделитель стилей в документ.
InsertTableOfContents(string) Вставляет поле TOC (оглавление) в документ.
InsertTextInput(string, TextFormFieldType, string, string, int) Вставляет поле текстовой формы в текущую позицию.
MoveTo(Node) Перемещает курсор на встроенный узел или в конец абзаца.
MoveToBookmark(string) Перемещает курсор на закладку.
MoveToBookmark(string, bool, bool) Перемещает курсор к закладке с большей точностью.
MoveToCell(int, int, int, int) Перемещает курсор в ячейку таблицы в текущем разделе.
MoveToDocumentEnd() Перемещает курсор в конец документа.
MoveToDocumentStart() Перемещает курсор в начало документа.
MoveToField(Field, bool) Перемещает курсор в поле документа.
MoveToHeaderFooter(HeaderFooterType) Перемещает курсор в начало верхнего или нижнего колонтитула в текущем разделе.
MoveToMergeField(string) Перемещает курсор в положение сразу за указанным полем слияния и удаляет поле слияния.
MoveToMergeField(string, bool, bool) Перемещает поле слияния в указанное поле слияния.
MoveToParagraph(int, int) Перемещает курсор на абзац в текущем разделе.
MoveToSection(int) Перемещает курсор в начало тела в указанном разделе.
PopFont() Извлекает форматирование символов, ранее сохраненное в стеке.
PushFont() Сохраняет текущее форматирование символов в стеке.
StartBookmark(string) Помечает текущую позицию в документе как начало закладки.
StartColumnBookmark(string) Помечает текущую позицию в документе как начало закладки столбца. Позиция должна быть в ячейке таблицы.
StartEditableRange() Помечает текущую позицию в документе как начало редактируемого диапазона.
StartTable() Запускает таблицу в документе.
Write(string) Вставляет строку в документ в текущей позиции вставки.
Writeln() Вставляет разрыв абзаца в документ.
Writeln(string) Вставляет в документ строку и разрыв абзаца.

Примечания

DocumentBuilder делает процесс создания Документ проще. Документпредставляет собой составной объект, состоящий из дерева узлов, и хотя вставка узлов content непосредственно в дерево возможна, это требует хорошего понимания структуры дерева. DocumentBuilder является «фасадом» сложной структуры Документ и позволяет быстро и легко вставлять содержимое и форматирование.

Создать DocumentBuilder и связать его сDocument.

DocumentBuilder имеет внутренний курсор, куда будет вставляться текст при вызовеWrite ,Writeln ,InsertBreak и другие методы. Вы можете перемещаться по DocumentBuilder курсор в другое место в документе с использованием различных методов MoveToXXX.

ИспользоватьFont свойство, чтобы указать форматирование символов, которое будет применяться ко всему тексту, вставляемому с текущей позиции в документе.

ИспользоватьParagraphFormat чтобы указать форматирование абзаца для current и всех абзацев, которые будут вставлены.

ИспользоватьPageSetupсвойство, чтобы указать свойства страницы и раздела для раздела current и всех разделов, которые будут вставлены.

ИспользоватьCellFormat а такжеRowFormat properties для указания свойств форматирования для ячеек и строк таблицы. ПользовательInsertCell и EndRow методы построения таблицы.

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

Примеры

Показывает, как использовать конструктор документов для создания таблицы.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Запускаем таблицу, затем заполняем первую строку двумя ячейками.
builder.StartTable();
builder.InsertCell();
builder.Write("Row 1, Cell 1.");
builder.InsertCell();
builder.Write("Row 1, Cell 2.");

// Вызовите метод "EndRow" построителя, чтобы начать новую строку.
builder.EndRow();
builder.InsertCell();
builder.Write("Row 2, Cell 1.");
builder.InsertCell();
builder.Write("Row 2, Cell 2.");
builder.EndTable();

doc.Save(ArtifactsDir + "DocumentBuilder.CreateTable.docx");

Показывает, как создавать верхние и нижние колонтитулы в документе с помощью DocumentBuilder.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Указываем, что нам нужны разные верхние и нижние колонтитулы для первой, четной и нечетной страниц.
builder.PageSetup.DifferentFirstPageHeaderFooter = true;
builder.PageSetup.OddAndEvenPagesHeaderFooter = true;

// Создайте заголовки, затем добавьте в документ три страницы для отображения каждого типа заголовков.
builder.MoveToHeaderFooter(HeaderFooterType.HeaderFirst);
builder.Write("Header for the first page");
builder.MoveToHeaderFooter(HeaderFooterType.HeaderEven);
builder.Write("Header for even pages");
builder.MoveToHeaderFooter(HeaderFooterType.HeaderPrimary);
builder.Write("Header for all other pages");

builder.MoveToSection(0);
builder.Writeln("Page1");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Page2");
builder.InsertBreak(BreakType.PageBreak);
builder.Writeln("Page3");

doc.Save(ArtifactsDir + "DocumentBuilder.HeadersAndFooters.docx");

Показывает, как построить таблицу с пользовательскими границами.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.StartTable();

// Установка параметров форматирования таблицы для конструктора документов
// применит их к каждой строке и ячейке, которые мы добавляем вместе с ней.
builder.ParagraphFormat.Alignment = ParagraphAlignment.Center;

builder.CellFormat.ClearFormatting();
builder.CellFormat.Width = 150;
builder.CellFormat.VerticalAlignment = CellVerticalAlignment.Center;
builder.CellFormat.Shading.BackgroundPatternColor = Color.GreenYellow;
builder.CellFormat.WrapText = false;
builder.CellFormat.FitText = true;

builder.RowFormat.ClearFormatting();
builder.RowFormat.HeightRule = HeightRule.Exactly;
builder.RowFormat.Height = 50;
builder.RowFormat.Borders.LineStyle = LineStyle.Engrave3D;
builder.RowFormat.Borders.Color = Color.Orange;

builder.InsertCell();
builder.Write("Row 1, Col 1");

builder.InsertCell();
builder.Write("Row 1, Col 2");
builder.EndRow();

// Изменение форматирования применит его к текущей ячейке,
// и любые новые ячейки, которые мы впоследствии создадим с помощью конструктора.
// Это не повлияет на ячейки, которые мы добавили ранее.
builder.CellFormat.Shading.ClearFormatting();

builder.InsertCell();
builder.Write("Row 2, Col 1");

builder.InsertCell();
builder.Write("Row 2, Col 2");

builder.EndRow();

// Увеличиваем высоту строки, чтобы она соответствовала вертикальному тексту.
builder.InsertCell();
builder.RowFormat.Height = 150;
builder.CellFormat.Orientation = TextOrientation.Upward;
builder.Write("Row 3, Col 1");

builder.InsertCell();
builder.CellFormat.Orientation = TextOrientation.Downward;
builder.Write("Row 3, Col 2");

builder.EndRow();
builder.EndTable();

doc.Save(ArtifactsDir + "DocumentBuilder.InsertTable.docx");

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