FieldHyperlink

Реализует поле HYPERLINK

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

public class FieldHyperlink : Field

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

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

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

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

Методы

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

Примечания

При выборе этого параметра элемент управления переходит к такому местоположению, как закладка или URL-адрес.

Примеры

Показывает, как использовать поля HYPERLINK для ссылки на документы в локальной файловой системе.

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

FieldHyperlink field = (FieldHyperlink)builder.InsertField(FieldType.FieldHyperlink, true);

// Когда мы нажимаем на это поле ГИПЕРССЫЛКА в Microsoft Word,
// откроется связанный документ, а затем курсор будет установлен на указанной закладке.
field.Address = MyDir + "Bookmarks.docx";
field.SubAddress = "MyBookmark3";
field.ScreenTip = "Open " + field.Address + " on bookmark " + field.SubAddress + " in a new window";

builder.Writeln();

// Когда мы нажимаем на это поле ГИПЕРССЫЛКА в Microsoft Word,
// откроется связанный документ и автоматически прокрутится вниз до указанного iframe.
field = (FieldHyperlink)builder.InsertField(FieldType.FieldHyperlink, true);
field.Address = MyDir + "Iframes.html";
field.ScreenTip = "Open " + field.Address;
field.Target = "iframe_3";
field.OpenInNewWindow = true;
field.IsImageMap = false;

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

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

FieldGreetingLine Class FieldIf Class