Aspose::Words::Fields::FieldHyperlink class
Содержание
[
Скрывать
]FieldHyperlink class
Реализует поле HYPERLINK. Чтобы узнать больше, посетите статью документации Working with Fields .
class FieldHyperlink : public Aspose::Words::Fields::Field,
public Aspose::Words::Fields::IFieldCodeTokenInfoProvider,
public Aspose::Words::Fields::IFieldResultFormatProvider
Методы
| Метод | Описание |
|---|---|
| get_Address() | Получает или задает расположение, куда переходит эта гиперссылка. |
| get_DisplayResult() | Получает текст, представляющий отображаемый результат поля. |
| get_End() const | Получает узел, представляющий конец поля. |
| get_FieldEnd() const | Получает узел, представляющий конец поля. |
| get_FieldStart() const | Получает узел, представляющий начало поля. |
| get_Format() | Получает объект FieldFormat, который предоставляет типизированный доступ к форматированию поля. |
| get_IsDirty() | Получает или задает, является ли текущий результат поля более некорректным (устаревшим) из‑за других изменений, внесённых в документ. |
| get_IsImageMap() | Получает или задает, следует ли добавлять координаты к гиперссылке для серверной карты изображений. |
| get_IsLocked() | Получает или задает, заблокировано ли поле (не должно пересчитывать свой результат). |
| get_LocaleId() | Получает или задает LCID поля. |
| get_OpenInNewWindow() | Получает или задает, открывать ли целевой сайт в новом окне веб-браузера. |
| get_Result() | Получает или задает текст, находящийся между разделителем поля и его концом. |
| get_ScreenTip() | Получает или задает текст подсказки ScreenTip для гиперссылки. |
| get_Separator() | Получает узел, представляющий разделитель поля. Может быть null. |
| get_Start() const | Получает узел, представляющий начало поля. |
| get_SubAddress() | Получает или задает расположение в файле, например закладку, куда переходит эта гиперссылка. |
| get_Target() | Получает или задает цель, на которую должна перенаправляться ссылка. |
| virtual get_Type() const | Получает тип поля Microsoft Word. |
| GetFieldCode() | Возвращает текст между началом поля и разделителем поля (или концом поля, если разделитель отсутствует). Включены как код поля, так и результат дочерних полей. |
| GetFieldCode(bool) | Возвращает текст между началом поля и разделителем поля (или концом поля, если разделитель отсутствует). |
| GetType() const override | |
| Is(const System::TypeInfo&) const override | |
| virtual Remove() | Удаляет поле из документа. Возвращает узел сразу после поля. Если конец поля является последним дочерним элементом его родительского узла, возвращает родительский абзац. Если поле уже удалено, возвращает null. |
| set_Address(const System::String&) | Сеттер для Aspose::Words::Fields::FieldHyperlink::get_Address. |
| set_IsDirty(bool) | Сеттер для Aspose::Words::Fields::Field::get_IsDirty. |
| set_IsImageMap(bool) | Сеттер для Aspose::Words::Fields::FieldHyperlink::get_IsImageMap. |
| set_IsLocked(bool) | Сеттер для Aspose::Words::Fields::Field::get_IsLocked. |
| set_LocaleId(int32_t) | Сеттер для Aspose::Words::Fields::Field::get_LocaleId. |
| set_OpenInNewWindow(bool) | Сеттер для Aspose::Words::Fields::FieldHyperlink::get_OpenInNewWindow. |
| set_Result(const System::String&) | Сеттер для Aspose::Words::Fields::Field::get_Result. |
| set_ScreenTip(const System::String&) | Сеттер для Aspose::Words::Fields::FieldHyperlink::get_ScreenTip. |
| set_SubAddress(const System::String&) | Сеттер для Aspose::Words::Fields::FieldHyperlink::get_SubAddress. |
| set_Target(const System::String&) | Сеттер для Aspose::Words::Fields::FieldHyperlink::get_Target. |
| static Type() | |
| Unlink() | Выполняет отсоединение поля. |
| Update() | Выполняет обновление поля. Вызывает исключение, если поле уже обновляется. |
| Update(bool) | Выполняет обновление поля. Выбрасывает исключение, если поле уже обновляется. |
Примеры
Показывает, как использовать поля HYPERLINK для ссылки на документы в локальной файловой системе.
auto doc = System::MakeObject<Aspose::Words::Document>();
auto builder = System::MakeObject<Aspose::Words::DocumentBuilder>(doc);
auto field = System::ExplicitCast<Aspose::Words::Fields::FieldHyperlink>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldHyperlink, true));
// Когда мы щёлкаем это поле HYPERLINK в Microsoft Word,
// оно откроет связанный документ, а затем разместит курсор в указанной закладке.
field->set_Address(get_MyDir() + u"Bookmarks.docx");
field->set_SubAddress(u"MyBookmark3");
field->set_ScreenTip(System::String(u"Open ") + field->get_Address() + u" on bookmark " + field->get_SubAddress() + u" in a new window");
builder->Writeln();
// Когда мы щёлкаем это поле HYPERLINK в Microsoft Word,
// оно откроет связанный документ и автоматически прокрутит вниз до указанного iframe.
field = System::ExplicitCast<Aspose::Words::Fields::FieldHyperlink>(builder->InsertField(Aspose::Words::Fields::FieldType::FieldHyperlink, true));
field->set_Address(get_MyDir() + u"Iframes.html");
field->set_ScreenTip(System::String(u"Open ") + field->get_Address());
field->set_Target(u"iframe_3");
field->set_OpenInNewWindow(true);
field->set_IsImageMap(false);
doc->UpdateFields();
doc->Save(get_ArtifactsDir() + u"Field.HYPERLINK.docx");
См. также
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++
