Вставка полей
Существует несколько различных способов вставки полей в документ:
- используя DocumentBuilder
- используя FieldBuilder
- с помощью Aspose.Words Объектная модель документа (DOM)
В этой статье мы рассмотрим каждый из способов более подробно и проанализируем, как вставлять определенные поля, используя эти опции.
Вставка полей в документ с помощью DocumentBuilder
В случае Aspose.Words метод InsertField используется для вставки новых полей в документ. Первый параметр принимает полный код поля, которое необходимо вставить. Второй параметр является необязательным и позволяет вручную задать результат заполнения поля. Если это значение не указано, поле обновляется автоматически. Вы можете задать значение null или empty для этого параметра, чтобы вставить поле с пустым значением. Если вы не уверены в синтаксисе конкретного кода поля, сначала создайте поле в Microsoft Word и переключитесь, чтобы просмотреть его код.
В следующем примере кода показано, как вставить поле слияния в документ с помощью DocumentBuilder:
For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-C | |
auto doc = MakeObject<Document>(); | |
auto builder = MakeObject<DocumentBuilder>(doc); | |
builder->InsertField(u"MERGEFIELD MyFieldName \\* MERGEFORMAT"); | |
doc->Save(ArtifactsDir + u"WorkingWithFields.InsertField.docx"); |
Тот же метод используется для вставки полей, вложенных в другие поля.
В следующем примере кода показано, как вставить поля, вложенные в другое поле, используя DocumentBuilder:
// For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-C | |
auto doc = MakeObject<Document>(); | |
auto builder = MakeObject<DocumentBuilder>(doc); | |
// Insert a few page breaks (just for testing) | |
for (int i = 0; i < 5; i++) | |
{ | |
builder->InsertBreak(BreakType::PageBreak); | |
} | |
// Move the DocumentBuilder cursor into the primary footer. | |
builder->MoveToHeaderFooter(HeaderFooterType::FooterPrimary); | |
// We want to insert a field like this: | |
// { IF {PAGE} <> {NUMPAGES} "See Next Page" "Last Page" } | |
System::SharedPtr<Field> field = builder->InsertField(u"IF "); | |
builder->MoveTo(field->get_Separator()); | |
builder->InsertField(u"PAGE"); | |
builder->Write(u" <> "); | |
builder->InsertField(u"NUMPAGES"); | |
builder->Write(u" \"See Next Page\" \"Last Page\" "); | |
field->Update(); | |
doc->Save(ArtifactsDir + u"WorkingWithFields.InsertNestedFields.docx"); |
Укажите языковой стандарт на уровне поля
Идентификатор языка - это стандартное международное цифровое сокращение для обозначения языка в стране или географическом регионе. С помощью Aspose.Words вы можете указать языковой стандарт на уровне поля, используя свойство LocaleId, которое возвращает или задает языковой идентификатор поля.
В следующем примере кода показано, как использовать эту опцию:
//For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-C | |
auto builder = MakeObject<DocumentBuilder>(); | |
SharedPtr<Field> field = builder->InsertField(FieldType::FieldDate, true); | |
field->set_LocaleId(1049); | |
builder->get_Document()->Save(ArtifactsDir + u"WorkingWithFields.SpecifylocaleAtFieldlevel.docx"); |
Вставить Нетипизированное/пустое поле
Если вы хотите вставить нетипизированные/пустые поля ({}), как это позволяет Microsoft Word, вы можете использовать метод InsertField с параметром FieldType.FieldNone. Чтобы вставить поле в документ Word, вы можете нажать комбинацию клавиш “Ctrl + F9”.
В следующем примере кода показано, как вставить пустое поле в документ:
//For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-C | |
auto doc = MakeObject<Document>(); | |
auto builder = MakeObject<DocumentBuilder>(doc); | |
auto field = System::DynamicCast<FieldUnknown>(builder->InsertField(FieldType::FieldNone, false)); | |
doc->Save(ArtifactsDir + u"WorkingWithFields.InsertFieldNone.docx"); |
Вставка полей в документ с помощью FieldBuilder
Альтернативным способом вставки полей в Aspose.Words является класс FieldBuilder. Он предоставляет удобный интерфейс для указания переключателей полей и значений аргументов в виде текста, узлов или даже вложенных полей.
В следующем примере кода показано, как вставить поле в документ с помощью FieldBuilder:
//For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-C | |
auto doc = MakeObject<Document>(); | |
auto firstName = MakeObject<FieldBuilder>(FieldType::FieldMergeField); | |
firstName->AddArgument("firstname"); | |
auto lastName = MakeObject<FieldBuilder>(FieldType::FieldMergeField); | |
lastName->AddArgument("lastname"); | |
auto firstnameArgumentBuilder = MakeObject<FieldArgumentBuilder>(); | |
firstnameArgumentBuilder->AddText(u"Firstname: "); | |
firstnameArgumentBuilder->AddField(firstName); | |
auto lastnameArgumentBuilder = MakeObject<FieldArgumentBuilder>(); | |
lastnameArgumentBuilder->AddText(u"Lastname: "); | |
lastnameArgumentBuilder->AddField(lastName); | |
// Prepare IF field with two nested MERGEFIELD fields: { IF "left expression" = "right expression" "Firstname: { MERGEFIELD firstname }" "Lastname: { MERGEFIELD lastname }"} | |
auto fieldBuilder = MakeObject<FieldBuilder>(FieldType::FieldIf); | |
fieldBuilder->AddArgument(u"left expression"); | |
fieldBuilder->AddArgument(u"="); | |
fieldBuilder->AddArgument(u"right expression"); | |
fieldBuilder->AddArgument(firstnameArgumentBuilder); | |
fieldBuilder->AddArgument(lastnameArgumentBuilder); | |
auto field = fieldBuilder->BuildAndInsert(doc->get_FirstSection()->get_Body()->AppendParagraph(String::Empty)); | |
field->Update(); | |
doc->Save(ArtifactsDir + u"Field.InsertFieldUsingFieldBuilder.docx"); |
Вставка полей с помощью DOM
Вы также можете вставлять поля различных типов, используя Aspose.Words Объектную модель документа (DOM). В этом разделе мы рассмотрим несколько примеров.
Вставка поля слияния в документ с помощью DOM
Поле MERGEFIELD
в документе Word может быть представлено классом FieldMergeField. Класс FieldMergeField можно использовать для выполнения следующих операций:
- укажите название поля для объединения
- укажите форматирование поля для объединения
- укажите текст, который находится между разделителем полей и концом поля в поле объединения
- укажите текст, который будет вставлен после поля объединения, если это поле не является пустым
- укажите текст, который будет вставлен перед полем объединения, если это поле не является пустым
В следующем примере кода показано, как добавить поле MERGE
с помощью DOM в абзац документа:
//For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-C | |
auto doc = MakeObject<Document>(); | |
auto builder = MakeObject<DocumentBuilder>(doc); | |
auto para = System::DynamicCast<Paragraph>(doc->GetChildNodes(NodeType::Paragraph, true)->idx_get(0)); | |
builder->MoveTo(para); | |
// We want to insert a merge field like this: | |
// { " MERGEFIELD Test1 \\b Test2 \\f Test3 \\m \\v" } | |
auto field = System::DynamicCast<FieldMergeField>(builder->InsertField(FieldType::FieldMergeField, false)); | |
// { " MERGEFIELD Test1" } | |
field->set_FieldName(u"Test1"); | |
// { " MERGEFIELD Test1 \\b Test2" } | |
field->set_TextBefore(u"Test2"); | |
// { " MERGEFIELD Test1 \\b Test2 \\f Test3 } | |
field->set_TextAfter(u"Test3"); | |
// { " MERGEFIELD Test1 \\b Test2 \\f Test3 \\m" } | |
field->set_IsMapped(true); | |
// { " MERGEFIELD Test1 \\b Test2 \\f Test3 \\m \\v" } | |
field->set_IsVerticalFormatting(true); | |
field->Update(); | |
doc->Save(ArtifactsDir + u"WorkingWithFields.InsertMergeFieldUsingDOM.docx"); |
Вставка поля адресного блока Mail Merge в документ с использованием DOM
Поле ADDRESSBLOCK
используется для вставки адресного блока Mail Merge в документ Word. Поле ADDRESSBLOCK
в документе Word может быть представлено классом FieldAddressBlock. Класс FieldAddressBlock можно использовать для выполнения следующих операций:
- укажите, следует ли указывать название страны/региона в этом поле
- укажите, следует ли форматировать адрес в соответствии со страной/регионом получателя, указанным в почтовом индексе* (Всемирный почтовый союз, 2006)
- укажите название исключенной страны/региона
- укажите формат имени и адреса
- укажите идентификатор языка, используемый для форматирования адреса
В следующем примере кода показано, как добавить поле Mail Merge ADDRESSBLOCK
с помощью DOM в абзац документа:
//For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-C | |
auto doc = MakeObject<Document>(); | |
auto builder = MakeObject<DocumentBuilder>(doc); | |
auto para = System::DynamicCast<Paragraph>(doc->GetChildNodes(NodeType::Paragraph, true)->idx_get(0)); | |
builder->MoveTo(para); | |
// We want to insert a mail merge address block like this: | |
// { ADDRESSBLOCK \\c 1 \\d \\e Test2 \\f Test3 \\l \"Test 4\" } | |
auto field = System::DynamicCast<FieldAddressBlock>(builder->InsertField(FieldType::FieldAddressBlock, false)); | |
// { ADDRESSBLOCK \\c 1" } | |
field->set_IncludeCountryOrRegionName(u"1"); | |
// { ADDRESSBLOCK \\c 1 \\d" } | |
field->set_FormatAddressOnCountryOrRegion(true); | |
// { ADDRESSBLOCK \\c 1 \\d \\e Test2 } | |
field->set_ExcludedCountryOrRegionName(u"Test2"); | |
// { ADDRESSBLOCK \\c 1 \\d \\e Test2 \\f Test3 } | |
field->set_NameAndAddressFormat(u"Test3"); | |
// { ADDRESSBLOCK \\c 1 \\d \\e Test2 \\f Test3 \\l \"Test 4\" } | |
field->set_LanguageId(u"Test 4"); | |
field->Update(); | |
doc->Save(ArtifactsDir + u"WorkingWithFields.InsertMailMergeAddressBlockFieldUsingDOM.docx"); | |
Вставка поля Advance в документ без использования DocumentBuilder
Поле ADVANCE
используется для смещения последующего текста в строке влево, вправо, вверх или вниз. Поле ADVANCE
в документе Word может быть представлено классом FieldAdvance. Класс FieldAdvance можно использовать для выполнения следующих операций:
- укажите количество точек, на которые текст, следующий за полем, должен быть перемещен по вертикали от верхнего края страницы
- укажите количество точек, на которое текст, следующий за полем, должен быть перемещен по горизонтали от левого края столбца, рамки или текстового поля
- укажите количество точек, на которые текст, следующий за полем, должен быть перемещен влево, вправо, вверх или вниз
В следующем примере кода показано, как добавить поле ADVANCE
с помощью DOM в абзац документа:
//For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-C | |
auto doc = MakeObject<Document>(); | |
auto para = System::DynamicCast<Paragraph>(doc->GetChildNodes(NodeType::Paragraph, true)->idx_get(0)); | |
// We want to insert an Advance field like this: | |
// { ADVANCE \\d 10 \\l 10 \\r -3.3 \\u 0 \\x 100 \\y 100 } | |
auto field = System::DynamicCast<FieldAdvance>(para->AppendField(FieldType::FieldAdvance, false)); | |
// { ADVANCE \\d 10 " } | |
field->set_DownOffset(u"10"); | |
// { ADVANCE \\d 10 \\l 10 } | |
field->set_LeftOffset(u"10"); | |
// { ADVANCE \\d 10 \\l 10 \\r -3.3 } | |
field->set_RightOffset(u"-3.3"); | |
// { ADVANCE \\d 10 \\l 10 \\r -3.3 \\u 0 } | |
field->set_UpOffset(u"0"); | |
// { ADVANCE \\d 10 \\l 10 \\r -3.3 \\u 0 \\x 100 } | |
field->set_HorizontalPosition(u"100"); | |
// { ADVANCE \\d 10 \\l 10 \\r -3.3 \\u 0 \\x 100 \\y 100 } | |
field->set_VerticalPosition(u"100"); | |
field->Update(); | |
doc->Save(ArtifactsDir + u"WorkingWithFields.InsertAdvanceFieldWithOutDocumentBuilder.docx"); |
Вставка поля ASK
в документ без использования DocumentBuilder
Поле ASK
используется для запроса текста, который пользователь должен присвоить закладке в документе Word. Поле ASK
в документе Word может быть представлено классом FieldAsk. Класс FieldAsk можно использовать для выполнения следующих операций:
- укажите название закладки
- укажите ответ пользователя по умолчанию (начальное значение, содержащееся в окне запроса)
- укажите, должен ли ответ пользователя быть получен один раз за операцию mail merge
- укажите текст запроса (заголовок окна запроса)
В следующем примере кода показано, как добавить поле ASK
с помощью DOM в абзац документа:
//For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-C | |
auto doc = MakeObject<Document>(); | |
auto para = System::DynamicCast<Paragraph>(doc->GetChildNodes(NodeType::Paragraph, true)->idx_get(0)); | |
// We want to insert an Ask field like this: | |
// { ASK \"Test 1\" Test2 \\d Test3 \\o } | |
auto field = System::DynamicCast<FieldAsk>(para->AppendField(FieldType::FieldAsk, false)); | |
// { ASK \"Test 1\" " } | |
field->set_BookmarkName(u"Test 1"); | |
// { ASK \"Test 1\" Test2 } | |
field->set_PromptText(u"Test2"); | |
// { ASK \"Test 1\" Test2 \\d Test3 } | |
field->set_DefaultResponse(u"Test3"); | |
// { ASK \"Test 1\" Test2 \\d Test3 \\o } | |
field->set_PromptOnceOnMailMerge(true); | |
field->Update(); | |
doc->Save(ArtifactsDir + u"WorkingWithFields.InsertASKFieldWithOutDocumentBuilder.docx"); |
Вставка поля AUTHOR
в документ без использования DocumentBuilder
Поле AUTHOR
используется для указания имени автора документа в свойствах Document
. Поле AUTHOR
в документе Word может быть представлено классом FieldAuthor. Класс FieldAuthor можно использовать для выполнения следующих операций:
- укажите имя автора документа
В следующем примере кода показано, как добавить поле AUTHOR
с помощью DOM в абзац документа:
Вставка поля INCLUDETEXT
в документ без использования DocumentBuilder
В поле INCLUDETEXT
вставляется текст и графические изображения, содержащиеся в документе, название которого указано в коде поля. Вы можете вставить весь документ или часть документа, на который ссылается закладка. Это поле в документе Word представлено параметром INCLUDETEXT. Вы можете использовать класс FieldIncludeText для выполнения следующих операций:
- укажите название закладки для включенного документа
- укажите местоположение документа
В следующем примере кода показано, как добавить поле INCLUDETEXT
с помощью DOM в абзац документа:
//For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-C | |
auto doc = MakeObject<Document>(); | |
auto para = MakeObject<Paragraph>(doc); | |
// We want to insert an INCLUDETEXT field like this: | |
// { INCLUDETEXT "file path" } | |
auto fieldIncludeText = System::DynamicCast<FieldIncludeText>(para->AppendField(FieldType::FieldIncludeText, false)); | |
fieldIncludeText->set_BookmarkName(u"bookmark"); | |
fieldIncludeText->set_SourceFullName(MyDir + u"IncludeText.docx"); | |
doc->get_FirstSection()->get_Body()->AppendChild(para); | |
fieldIncludeText->Update(); | |
doc->Save(ArtifactsDir + u"WorkingWithFields.InsertIncludeFieldWithoutDocumentBuilder.docx"); |
Вставка поля TOA
в документ без использования DocumentBuilder
В поле TOA
(Table of Authorities) создается и вставляется таблица полномочий. В поле TOA
собираются записи, помеченные полями TA
(Table of Authorities Entry). Microsoft Office Word вставляет поле TOA
, когда вы нажимаете Insert Table of Authorities в группе Table of Authorities на вкладке References. При просмотре поля TOA
в вашем документе синтаксис будет выглядеть следующим образом:
{ TOA
[Switches ] }
В следующем примере кода показано, как добавить поле TOA
с помощью DOM в абзац документа:
//For complete examples and data files, please go to https://github.com/aspose-words/Aspose.Words-for-C | |
auto doc = MakeObject<Document>(); | |
auto para = MakeObject<Paragraph>(doc); | |
// We want to insert TA and TOA fields like this: | |
// { TA \c 1 \l "Value 0" } | |
// { TOA \c 1 } | |
auto fieldTA = System::DynamicCast<FieldTA>(para->AppendField(FieldType::FieldTOAEntry, false)); | |
fieldTA->set_EntryCategory(u"1"); | |
fieldTA->set_LongCitation(u"Value 0"); | |
doc->get_FirstSection()->get_Body()->AppendChild(para); | |
para = MakeObject<Paragraph>(doc); | |
auto fieldToa = System::DynamicCast<FieldToa>(para->AppendField(FieldType::FieldTOA, false)); | |
fieldToa->set_EntryCategory(u"1"); | |
doc->get_FirstSection()->get_Body()->AppendChild(para); | |
fieldToa->Update(); | |
doc->Save(ArtifactsDir + u"WorkingWithFields.InsertTOAFieldWithoutDocumentBuilder.docx"); |