FieldAsk

FieldAsk class

Реализует поле ASK.

Чтобы узнать больше, посетитеРабота с полями документальная статья.

public class FieldAsk : Field

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

Имя	Описание
FieldAsk()	Конструктор по умолчанию.

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

Имя	Описание
BookmarkName { get; set; }	Получает или задает имя закладки.
DefaultResponse { get; set; }	Возвращает или задает ответ пользователя по умолчанию (начальное значение, содержащееся в окне подсказки).
DisplayResult { get; }	Получает текст, представляющий отображаемый результат поля.
End { get; }	Получает узел, представляющий конец поля.
Format { get; }	Получает`FieldFormat`объект, который обеспечивает типизированный доступ к форматированию поля.
IsDirty { get; set; }	Возвращает или задает, является ли текущий результат поля более неверным (устаревшим) из-за других изменений, внесенных в документ.
IsLocked { get; set; }	Возвращает или задает, заблокировано ли поле (не следует пересчитывать его результат).
LocaleId { get; set; }	Получает или задает LCID поля.
PromptOnceOnMailMerge { get; set; }	Возвращает или задает, должен ли ответ пользователя быть получен один раз за операцию слияния почты.
PromptText { get; set; }	Получает или задает текст подсказки (заголовок окна подсказки).
Result { get; set; }	Возвращает или задает текст, который находится между разделителем полей и концом поля.
Separator { get; }	Получает узел, представляющий разделитель полей. Может быть`нулевой` .
Start { get; }	Получает узел, представляющий начало поля.
virtual Type { get; }	Получает тип поля Microsoft Word.

Методы

Имя	Описание
GetFieldCode()	Возвращает текст между началом поля и разделителем полей (или концом поля, если разделитель отсутствует). Включаются как код поля, так и результат поля дочерних полей.
GetFieldCode(bool)	Возвращает текст между началом поля и разделителем полей (или концом поля, если разделитель отсутствует).
Remove()	Удаляет поле из документа. Возвращает узел сразу после поля. Если конец поля — последний child его родительского узла, возвращает его родительский абзац. Если поле уже удалено, возвращает`нулевой` .
Unlink()	Выполняет отмену связи поля.
Update()	Выполняет обновление поля. Выдает исключение, если поле уже обновляется.
Update(bool)	Выполняет обновление поля. Выдает исключение, если поле уже обновляется.

Примечания

Предлагает пользователю ввести информацию и назначает закладку для представления ответа пользователя.

Примеры

Показывает, как создать поле ASK и задать его свойства.

public void FieldAsk()
{
    Document doc = new Document();
    DocumentBuilder builder = new DocumentBuilder(doc);

    // Размещаем поле, в которое будет помещен ответ на наше поле ASK.
    FieldRef fieldRef = (FieldRef)builder.InsertField(FieldType.FieldRef, true);
    fieldRef.BookmarkName = "MyAskField";
    builder.Writeln();

    Assert.AreEqual(" REF  MyAskField", fieldRef.GetFieldCode());

    // Вставьте поле ASK и отредактируйте его свойства, чтобы ссылаться на наше поле REF по имени закладки.
    FieldAsk fieldAsk = (FieldAsk)builder.InsertField(FieldType.FieldAsk, true);
    fieldAsk.BookmarkName = "MyAskField";
    fieldAsk.PromptText = "Please provide a response for this ASK field";
    fieldAsk.DefaultResponse = "Response from within the field.";
    fieldAsk.PromptOnceOnMailMerge = true;
    builder.Writeln();

    Assert.AreEqual(
        " ASK  MyAskField \"Please provide a response for this ASK field\" \\d \"Response from within the field.\" \\o",
        fieldAsk.GetFieldCode());

    // Поля ASK применяют ответ по умолчанию к соответствующим полям REF во время слияния почты.
    DataTable table = new DataTable("My Table");
    table.Columns.Add("Column 1");
    table.Rows.Add("Row 1");
    table.Rows.Add("Row 2");

    FieldMergeField fieldMergeField = (FieldMergeField)builder.InsertField(FieldType.FieldMergeField, true);
    fieldMergeField.FieldName = "Column 1";

    // Мы можем изменить или переопределить ответ по умолчанию в наших полях ASK с помощью пользовательского ответчика на подсказки,
    // что произойдет во время слияния почты.
    doc.FieldOptions.UserPromptRespondent = new MyPromptRespondent();
    doc.MailMerge.Execute(table);

    doc.UpdateFields();
    doc.Save(ArtifactsDir + "Field.ASK.docx");
}

/// <summary>
/// Добавляет текст к ответу по умолчанию поля ASK во время слияния почты.
/// </summary>
private class MyPromptRespondent : IFieldUserPromptRespondent
{
    public string Respond(string promptText, string defaultResponse)
    {
        return "Response from MyPromptRespondent. " + defaultResponse;
    }
}

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

class Field
пространство имен Aspose.Words.Fields
сборка Aspose.Words

FieldArgumentBuilder Class FieldAuthor Class