Hyperlink Класс

Определение

Пространство имен:

DocumentFormat.OpenXml.Office2010.CustomUI

Сборка:

DocumentFormat.OpenXml.dll

Пакет:

DocumentFormat.OpenXml v3.0.1

Определяет класс гиперссылки.

Этот класс доступен в Office 2010 и более поздних версиях.

Когда объект сериализуется как xml, его полное имя — mso14:hyperlink.

public class Hyperlink : DocumentFormat.OpenXml.OpenXmlLeafElement

type Hyperlink = class
    inherit OpenXmlLeafElement

Public Class Hyperlink
Inherits OpenXmlLeafElement

Наследование

Object

OpenXmlElement

OpenXmlLeafElement

Hyperlink

Комментарии

2.3.50 CT_Hyperlink

Целевое пространство имен:http://schemas.microsoft.com/office/2009/07/customui

На который ссылается: CT_GroupControls, CT_GroupBox, CT_LayoutContainer

Задает элемент управления гиперссылкой.

Атрибуты:

идентификатор: Атрибут ST_UniqueID , как указано в разделе 2.4.22, указывающий идентификатор пользовательского элемента управления. Все пользовательские элементы управления ДОЛЖНЫ иметь уникальные идентификаторы. Атрибуты id, idQ и idMso являются взаимоисключающими. Во всех элементах управления должен быть указан именно один из этих атрибутов.

idQ: Атрибут ST_QID , как указано в разделе 2.4.17, который указывает полный идентификатор элемента управления. Этот атрибут используется для ссылки на элементы управления или контейнеры, созданные другими документами пользовательского интерфейса. Атрибуты id, idQ и idMso являются взаимоисключающими. Во всех элементах управления должен быть указан именно один из этих атрибутов.

ярлык: Атрибут ST_String , как указано в разделе 2.4.19, который указывает произвольную строку , которая предоставляет дополнительные сведения об этом элементе управления во время вызовов функции обратного вызова. Если этот атрибут опущен, значение по умолчанию равно пустой строке.

alignLabel: Атрибут ST_AlignLabel , как указано в разделе 2.4.2, который указывает, как метка этого элемента управления выравнивается относительно элемента управления. Если этот атрибут опущен, по умолчанию метка будет выравнивать верхний левый.

расширять: Атрибут ST_Expand , как указано в разделе 2.4.8, который указывает, как этот элемент управления расширяется в контейнере. Если этот атрибут опущен, элемент управления не разворачивается.

Включен:Логический атрибут, указывающий состояние включения этого элемента управления. Атрибуты enabled и getEnabled являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из атрибутов не указан, по умолчанию элемент управления будет включен.

getEnabled: Атрибут ST_Delegate , указывающий имя функции обратного вызова, вызываемой для определения включенного состояния этого элемента управления. Атрибуты enabled и getEnabled являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из атрибутов не указан, по умолчанию элемент управления будет включен.

видимый:Логический атрибут, указывающий состояние видимости этого элемента управления. Атрибуты visible и getVisible являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из атрибутов не указан, элемент управления по умолчанию будет отображаться.

getVisible: Атрибут ST_Delegate , указывающий имя функции обратного вызова, вызываемой для определения состояния видимости этого элемента управления. Атрибуты visible и getVisible являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из атрибутов не указан, элемент управления по умолчанию будет отображаться.

подсказка: Атрибут ST_Keytip , как указано в разделе 2.4.14, который указывает строку , отображаемую в качестве подсказки ключа для этого элемента управления. Атрибуты keytip и getKeytip являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из атрибутов не указан, подсказка ключа не отображается.

getKeytip: Атрибут ST_Delegate , указывающий имя функции обратного вызова, вызываемой для определения подсказки ключа для этого элемента управления. Атрибуты keytip и getKeytip являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из атрибутов не указан, подсказка ключа не отображается.

ярлык: Атрибут ST_String , указывающий строку, отображаемую в качестве метки этого элемента управления. Атрибуты метки и getLabel являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из атрибутов не указан, метка не отображается.

getLabel: Атрибут ST_Delegate , указывающий имя функции обратного вызова, вызываемой для определения метки этого элемента управления. Атрибуты метки и getLabel являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из атрибутов не указан, метка не отображается.

onAction: Атрибут ST_Delegate , как указано в разделе 2.4.7, который указывает имя функции обратного вызова, вызываемой при вызове этого элемента управления пользователем.

образ: Атрибут ST_Uri , как указано в разделе 2.4.23, указывающий идентификатор связи файла изображения, который используется в качестве значка для этого элемента управления. Атрибуты image, getImage и imageMso являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из этих атрибутов не указан, значок не отображается.

imageMso: Атрибут ST_ID , как указано в разделе 2.4.12, указывающий идентификатор встроенного изображения, используемого в качестве значка для этого элемента управления. Атрибуты image, getImage и imageMso являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из этих атрибутов не указан, значок не отображается.

getImage: Атрибут ST_Delegate , как указано в разделе 2.4.7, который указывает имя функции обратного вызова, вызываемой для определения значка этого элемента управления. Атрибуты image, getImage и imageMso являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из этих атрибутов не указан, значок не отображается.

подсказка: Атрибут ST_String , как указано в разделе 2.4.19, который указывает строку, отображаемую в качестве подсказки для этого элемента управления. Атрибуты screentip и getScreentip являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из атрибутов не указан, подсказка не отображается.

GetScreentip: Атрибут ST_Delegate , указывающий имя функции обратного вызова, вызываемой для определения подсказки этого элемента управления. Атрибуты screentip и getScreentip являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из атрибутов не указан, подсказка не отображается.

суперподвиг: Атрибут ST_String , указывающий строку, отображаемую в качестве расширенной подсказки экрана этого элемента управления. Атрибуты supertip и getSupertip являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из атрибутов не указан, расширенная подсказка экрана не отображается.

getSupertip: Атрибут ST_Delegate , указывающий имя функции обратного вызова, вызываемой для определения расширенной подсказки экрана этого элемента управления. Атрибуты supertip и getSupertip являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из атрибутов не указан, расширенная подсказка экрана не отображается.

цель: Атрибут ST_String , как указано в разделе 2.4.19, который указывает URL-адрес для этого элемента управления гиперссылкой. Атрибуты target, getTarget и onAction являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из этих атрибутов не указан, элемент управления гиперссылкой не выполняет никаких действий при вызове.

getTarget: Атрибут ST_Delegate , как указано в разделе 2.4.7, который указывает имя функции обратного вызова, вызываемой для определения целевого URL-адреса для этого элемента управления гиперссылкой. Атрибуты target, getTarget и onAction являются взаимоисключающими. Они НЕ ДОЛЖНЫ использоваться вместе. Если ни один из этих атрибутов не указан, элемент управления гиперссылкой не выполняет никаких действий при вызове.

Следующий фрагмент xml-схемы W3C ([XMLSCHEMA1] раздел 2.1) указывает содержимое этого сложного типа.

<xsd:complexType name="CT_Hyperlink">

<xsd:attributeGroup ref="AG_IDCustom"/>

<xsd:attributeGroup ref="AG_AlignAttributes"/>

<xsd:attributeGroup ref="AG_Expand"/>

<xsd:attributeGroup ref="AG_Enabled"/>

<xsd:attributeGroup ref="AG_Visible"/>

<xsd:attributeGroup ref="AG_Keytip"/>

<xsd:attributeGroup ref="AG_Label"/>

<xsd:attributeGroup ref="AG_Action"/>

<xsd:attributeGroup ref="AG_Image"/>

<xsd:attributeGroup ref="AG_Screentip"/>

<xsd:attribute name="target" type="ST_String" use="optional"/>

<xsd:attribute name="getTarget" type="ST_Delegate" use="optional"/>

</xsd:complexType>

Полная схема XML W3C см. в разделе 5.1 ([XMLSCHEMA1] раздел 2.1).

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

Hyperlink()

Инициализирует новый экземпляр класса Hyperlink.

Свойства

AlignLabel	alignLabel, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: alignLabel
ChildElements	Возвращает все дочерние узлы текущего элемента. (Унаследовано от OpenXmlElement)
Enabled	включено, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: enabled
Expand	expand, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: expand
ExtendedAttributes	Возвращает все расширенные атрибуты (атрибуты, не определенные в схеме) текущего элемента. (Унаследовано от OpenXmlElement)
Features	IFeatureCollection Возвращает для текущего элемента. Эта коллекция компонентов будет доступна только для чтения, но будет наследовать компоненты от родительской части и пакета, если они доступны. (Унаследовано от OpenXmlElement)
FirstChild	Возвращает первый дочерний элемент элемента OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если такого элемента OpenXmlElement нет. (Унаследовано от OpenXmlElement)
GetEnabled	getEnabled, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: getEnabled
GetImage	getImage, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: getImage
GetKeytip	getKeytip, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: getKeytip
GetLabel	getLabel, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: getLabel
GetScreentip	GetScreentip, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: getScreentip
GetSupertip	getSupertip, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: getSupertip
GetTarget	getTarget, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: getTarget
GetVisible	getVisible, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: getVisible
HasAttributes	Возвращает значение, указывающее, имеет ли текущий элемент какие-либо атрибуты. (Унаследовано от OpenXmlElement)
HasChildren	Возвращает значение, указывающее, содержит ли текущий элемент какие-либо дочерние элементы. (Унаследовано от OpenXmlLeafElement)
Id	id, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: id
Image	image, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: image
ImageMso	imageMso, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: imageMso
InnerText	Возвращает или задает объединенные значения узла и всех его дочерних элементов. (Унаследовано от OpenXmlElement)
InnerXml	Возвращает или задает разметку, представляющую только дочерние элементы текущего элемента. (Унаследовано от OpenXmlLeafElement)
Keytip	подсказка, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: keytip
Label	label, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: label
LastChild	Возвращает последний дочерний элемент элемента OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если такого элемента OpenXmlElement нет. (Унаследовано от OpenXmlElement)
LocalName	Возвращает локальное имя текущего элемента. (Унаследовано от OpenXmlElement)
MCAttributes	Возвращает или задает атрибуты совместимости разметки. Возвращает значение NULL, если для текущего элемента не определены атрибуты совместимости разметки. (Унаследовано от OpenXmlElement)
NamespaceDeclarations	Возвращает все объявления пространства имен, определенные в текущем элементе. Возвращает пустой перечислитель, если нет объявления пространства имен. (Унаследовано от OpenXmlElement)
NamespaceUri	Возвращает универсальный код ресурса (URI) пространства имен текущего элемента. (Унаследовано от OpenXmlElement)
OnAction	onAction, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: onAction
OpenXmlElementContext	Возвращает openXmlElementContext текущего элемента. (Унаследовано от OpenXmlElement)
OuterXml	Возвращает разметку, представляющую текущий элемент и все его дочерние элементы. (Унаследовано от OpenXmlElement)
Parent	Возвращает родительский элемент текущего элемента. (Унаследовано от OpenXmlElement)
Prefix	Возвращает префикс пространства имен текущего элемента. (Унаследовано от OpenXmlElement)
QualifiedId	idQ, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: idQ
Screentip	подсказка. Это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: экранная подсказка
Supertip	supertip, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: supertip
Tag	tag, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: тег
Target	target, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: target
Visible	видимо, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий атрибут в схеме: visible
XmlQualifiedName	Возвращает полное имя текущего элемента. (Унаследовано от OpenXmlElement)
XName	Возвращает полное имя текущего элемента. (Унаследовано от OpenXmlElement)

Методы

AddAnnotation(Object)	Добавляет объект в список заметок текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
AddNamespaceDeclaration(String, String)	Добавляет объявление пространства имен в текущий узел. (Унаследовано от OpenXmlElement)
Ancestors()	Перечисляет все предки текущего элемента. (Унаследовано от OpenXmlElement)
Ancestors<T>()	Перечисляет только предки текущего элемента, имеющие указанный тип. (Унаследовано от OpenXmlElement)
Annotation(Type)	Получение первого объекта заметки указанного типа из текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
Annotation<T>()	Получение первого объекта заметки указанного типа из текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
Annotations(Type)	Возвращает коллекцию заметок с указанным типом для текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
Annotations<T>()	Возвращает коллекцию заметок с указанным типом для текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Добавляет каждый элемент из списка элементов в конец списка дочерних элементов текущего элемента. (Унаследовано от OpenXmlElement)
Append(OpenXmlElement[])	Добавляет каждый элемент из массива элементов в конец списка дочерних элементов текущего элемента. (Унаследовано от OpenXmlElement)
AppendChild<T>(T)	Добавляет указанный элемент в конец списка дочерних узлов текущего элемента. (Унаследовано от OpenXmlElement)
ClearAllAttributes()	Очищает все атрибуты, включая как известные, так и расширенные атрибуты. (Унаследовано от OpenXmlElement)
Clone()	Создает дубликат текущего узла. (Унаследовано от OpenXmlElement)
CloneNode(Boolean)	Создает дубликат этого узла.
Descendants()	Перечисляет все потомки текущего элемента. (Унаследовано от OpenXmlElement)
Descendants<T>()	Перечисление всех потомков текущего элемента типа T. (Унаследовано от OpenXmlElement)
Elements()	Перечисляет все дочерние элементы текущего элемента. (Унаследовано от OpenXmlElement)
Elements<T>()	Перечисляет только дочерние элементы текущего элемента, имеющие указанный тип. (Унаследовано от OpenXmlElement)
ElementsAfter()	Перечисляет все одноуровневые элементы, которые следуют за текущим элементом и имеют тот же родительский элемент, что и текущий элемент. (Унаследовано от OpenXmlElement)
ElementsBefore()	Перечисляет все одноуровневые элементы, которые предшествуют текущему элементу и имеют тот же родительский элемент, что и текущий элемент. (Унаследовано от OpenXmlElement)
GetAttribute(String, String)	Возвращает атрибут Open XML с указанным именем тега и URI пространства имен. (Унаследовано от OpenXmlElement)
GetAttributes()	Возвращает список, содержащий копию всех атрибутов. (Унаследовано от OpenXmlElement)
GetEnumerator()	Возвращает перечислитель, который выполняет итерацию по дочерней коллекции. (Унаследовано от OpenXmlElement)
GetFirstChild<T>()	Находит первый дочерний элемент в типе T. (Унаследовано от OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Вставляет указанный элемент сразу после указанного ссылочного элемента. (Унаследовано от OpenXmlElement)
InsertAfterSelf<T>(T)	Вставляет указанный элемент сразу после текущего элемента. (Унаследовано от OpenXmlElement)
InsertAt<T>(T, Int32)	Вставляет указанный элемент по указанному индексу в список дочерних элементов текущего элемента. (Унаследовано от OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)	Вставляет указанный элемент непосредственно перед указанным ссылочным элементом. (Унаследовано от OpenXmlElement)
InsertBeforeSelf<T>(T)	Вставляет указанный элемент непосредственно перед текущим элементом. (Унаследовано от OpenXmlElement)
IsAfter(OpenXmlElement)	Определяет, отображается ли текущий элемент после указанного элемента в порядке документа. (Унаследовано от OpenXmlElement)
IsBefore(OpenXmlElement)	Определяет, отображается ли текущий элемент перед указанным элементом в порядке документа. (Унаследовано от OpenXmlElement)
LookupNamespace(String)	Разрешает префикс пространства имен в контексте текущего узла. (Унаследовано от OpenXmlElement)
LookupPrefix(String)	Находит соответствующий префикс для URI пространства имен в текущем элементе область. (Унаследовано от OpenXmlElement)
NextSibling()	Возвращает элемент OpenXmlElement, который сразу же следует за текущим элементом OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет следующего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
NextSibling<T>()	Возвращает элемент OpenXmlElement с указанным типом, который следует за текущим элементом OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет следующего OpenXmlElement. (Унаследовано от OpenXmlElement)
PrependChild<T>(T)	Вставляет указанный элемент в начало списка дочерних элементов текущего элемента. (Унаследовано от OpenXmlElement)
PreviousSibling()	Возвращает элемент OpenXmlElement, который непосредственно предшествует текущему элементу OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
PreviousSibling<T>()	Возвращает элемент OpenXmlElement с указанным типом, который предшествует текущему объекту OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
Remove()	Удаляет текущий элемент из родительского элемента. (Унаследовано от OpenXmlElement)
RemoveAllChildren()	Удаляет все дочерние элементы текущего элемента. (Унаследовано от OpenXmlLeafElement)
RemoveAllChildren<T>()	Удалите все дочерние элементы текущего элемента типа T. (Унаследовано от OpenXmlElement)
RemoveAnnotations(Type)	Удаляет заметки указанного типа из текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
RemoveAnnotations<T>()	Удаляет заметки с указанным типом из текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
RemoveAttribute(String, String)	Удаляет атрибут из текущего элемента. (Унаследовано от OpenXmlElement)
RemoveChild<T>(T)	Удаляет указанный дочерний элемент из списка дочерних элементов текущего элемента. (Унаследовано от OpenXmlElement)
RemoveNamespaceDeclaration(String)	Удаляет объявление пространства имен для указанного префикса. Ничего не удаляет, если нет префикса. (Унаследовано от OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Заменяет дочерний элемент другим дочерним элементом в списке дочерних элементов текущего элемента. (Унаследовано от OpenXmlElement)
SetAttribute(OpenXmlAttribute)	Задает атрибут заданного элемента. Если атрибут является известным атрибутом, задается значение атрибута. Если атрибут является расширенным атрибутом, в список расширенных атрибутов добавляется openxmlAttribute. (Унаследовано от OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Задает ряд атрибутов элемента . Если атрибут является известным атрибутом, задается значение атрибута. Если атрибут является расширенным атрибутом, в список расширенных атрибутов добавляется openxmlAttribute. (Унаследовано от OpenXmlElement)
WriteTo(XmlWriter)	Сохраняет текущий узел в указанном xmlWriter. (Унаследовано от OpenXmlElement)

Явные реализации интерфейса

IEnumerable.GetEnumerator()	Определяет класс гиперссылки. Этот класс доступен в Office 2010 и более поздних версиях. Когда объект сериализуется как xml, его полное имя — mso14:hyperlink. (Унаследовано от OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Возвращает перечислитель, который выполняет итерацию по дочерней коллекции. (Унаследовано от OpenXmlElement)