CustomDocumentProperty Класс

Определение

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

DocumentFormat.OpenXml.CustomProperties

Сборка:

DocumentFormat.OpenXml.dll

Пакет:

DocumentFormat.OpenXml v3.0.1

Пользовательское свойство файла.

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

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

public class CustomDocumentProperty : DocumentFormat.OpenXml.OpenXmlCompositeElement

type CustomDocumentProperty = class
    inherit OpenXmlCompositeElement

Public Class CustomDocumentProperty
Inherits OpenXmlCompositeElement

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

Object

OpenXmlElement

OpenXmlCompositeElement

CustomDocumentProperty

Комментарии

[ISO/IEC 29500-1 1 издание]

property (пользовательское свойство файла)

Этот элемент задает одно настраиваемое свойство файла. Пользовательский тип свойства файла определяется с помощью дочерних элементов в пространстве имен Variant Type свойств файла. Настраиваемое значение свойства файла можно задать, задав соответствующее значение дочернего элемента Variant Type.

Родительские элементы
Свойства (§22.3.2.1)

Дочерние элементы	Вложенные запросы
array (Array)	§22.4.2.1
BLOB-объект (двоичный BLOB-объект)	§22.4.2.2
bool (boolean)	§22.4.2.3
bstr (базовая строка)	§22.4.2.4
clsid (идентификатор класса)	§22.4.2.5
cy (валюта)	§22.4.2.6
date (дата и время)	§22.4.2.7
decimal (Decimal)	§22.4.2.8
empty (Empty)	§22.4.2.9
error (код состояния ошибки)	§22.4.2.10
filetime (время файла)	§22.4.2.11
i1 (1-байтовое целое число со знаком)	§22.4.2.12
i2 (2-байтовое целое число со знаком)	§22.4.2.13
i4 (4-байтовое целое число со знаком)	§22.4.2.14
i8 (8-байтовое целое число со знаком)	§22.4.2.15
int (integer)	§22.4.2.16
lpstr (LPSTR)	§22.4.2.17
lpwstr (LPWSTR)	§22.4.2.18
null (NULL)	§22.4.2.19
oblob (двоичный объект BLOB-объекта)	§22.4.2.20
ostorage (двоичный объект хранилища)	§22.4.2.21
ostream (двоичный объект Stream)	§22.4.2.22
r4 (4-байтовое реальное число)	§22.4.2.23
r8 (8-байтовое реальное число)	§22.4.2.24
хранилище (двоичное хранилище)	§22.4.2.25
stream (двоичный поток)	§22.4.2.26
ui1 (1-байтовое целое число без знака)	§22.4.2.27
ui2 (2-байтовое целое число без знака)	§22.4.2.28
ui4 (4-байтовое целое число без знака)	§22.4.2.29
ui8 (8-байтовое целое число без знака)	§22.4.2.30
uint (целое число без знака)	§22.4.2.31
vector (Vector)	§22.4.2.33
vstream (двоичный поток с версиями)	§22.4.2.34

Атрибуты	Описание
fmtid (идентификатор формата)	Уникально связывает пользовательское свойство со свойством OLE. Значение этого атрибута представляет собой глобальный уникальный идентификатор в виде {HHHHHHH-HHHH-HHHH-HHHH-HHHH-HHHHHHH}, где каждый H является шестнадцатеричным. Возможные значения для этого атрибута определяются простым типом ST_Guid (§22.9.2.4).
linkTarget (цель ссылки закладки)	Указывает имя закладки в текущем документе (для WordprocessingML) или таблицы или именованной ячейки (для SpreadsheetML), из которой должно быть извлечено значение этого настраиваемого свойства документа. Если этот атрибут присутствует, любое значение в этом элементе считается кэшем и заменено значением этой закладки (если оно есть) при сохранении. Если закладка отсутствует, то эта ссылка считается неисправной и кэшированное значение должно быть сохранено. Допустимые значения этого атрибута определяются типом данных string схемы XML (консорциум W3C).
name (имя пользовательского свойства файла)	Указывает имя этого настраиваемого свойства файла. Допустимые значения этого атрибута определяются типом данных string схемы XML (консорциум W3C).
pid (идентификатор свойства)	Уникально связывает пользовательское свойство со свойством OLE. Возможные значения для этого атрибута определяются типом данных W3C XML Schema int .

[Примечание. Определение xml-схемы W3C для модели содержимого этого элемента (CT_Property) находится в §A.6.3. конечная заметка]

ISO/IEC29500: 2008.

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

CustomDocumentProperty()	Инициализирует новый экземпляр класса CustomDocumentProperty.
CustomDocumentProperty(IEnumerable<OpenXmlElement>)	Инициализирует новый экземпляр класса CustomDocumentProperty с указанными дочерними элементами.
CustomDocumentProperty(OpenXmlElement[])	Инициализирует новый экземпляр класса CustomDocumentProperty с указанными дочерними элементами.
CustomDocumentProperty(String)	Инициализирует новый экземпляр класса CustomDocumentProperty из внешнего XML-кода.

Свойства

ChildElements	Возвращает все дочерние узлы текущего элемента. (Унаследовано от OpenXmlElement)
ExtendedAttributes	Возвращает все расширенные атрибуты (атрибуты, не определенные в схеме) текущего элемента. (Унаследовано от OpenXmlElement)
Features	IFeatureCollection Возвращает для текущего элемента. Эта коллекция компонентов будет доступна только для чтения, но будет наследовать компоненты от родительской части и пакета, если они доступны. (Унаследовано от OpenXmlElement)
FirstChild	Получает первый дочерний элемент текущего элемента OpenXmlElement. (Унаследовано от OpenXmlCompositeElement)
FormatId	Идентификатор формата Представляет следующий атрибут в схеме: fmtid
HasAttributes	Возвращает значение, указывающее, имеет ли текущий элемент какие-либо атрибуты. (Унаследовано от OpenXmlElement)
HasChildren	Возвращает значение, указывающее, содержит ли текущий элемент какие-либо дочерние элементы. (Унаследовано от OpenXmlCompositeElement)
InnerText	Возвращает или задает объединенные значения текущего узла и всех его дочерних элементов. (Унаследовано от OpenXmlCompositeElement)
InnerXml	Возвращает или задает разметку, представляющую только дочерние узлы текущего узла. (Унаследовано от OpenXmlCompositeElement)
LastChild	Возвращает последний дочерний элемент текущего элемента OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если такого элемента OpenXmlElement нет. (Унаследовано от OpenXmlCompositeElement)
LinkTarget	Цель ссылки на закладки Представляет следующий атрибут в схеме: linkTarget
LocalName	Возвращает локальное имя текущего элемента. (Унаследовано от OpenXmlElement)
MCAttributes	Возвращает или задает атрибуты совместимости разметки. Возвращает значение NULL, если для текущего элемента не определены атрибуты совместимости разметки. (Унаследовано от OpenXmlElement)
Name	Имя пользовательского свойства файла Представляет следующий атрибут в схеме: name
NamespaceDeclarations	Возвращает все объявления пространства имен, определенные в текущем элементе. Возвращает пустой перечислитель, если нет объявления пространства имен. (Унаследовано от OpenXmlElement)
NamespaceUri	Возвращает универсальный код ресурса (URI) пространства имен текущего элемента. (Унаследовано от OpenXmlElement)
OpenXmlElementContext	Возвращает openXmlElementContext текущего элемента. (Унаследовано от OpenXmlElement)
OuterXml	Возвращает разметку, представляющую текущий элемент и все его дочерние элементы. (Унаследовано от OpenXmlElement)
Parent	Возвращает родительский элемент текущего элемента. (Унаследовано от OpenXmlElement)
Prefix	Возвращает префикс пространства имен текущего элемента. (Унаследовано от OpenXmlElement)
PropertyId	Идентификатор свойства Представляет следующий атрибут в схеме: pid
VTArray	Массива. Представляет следующий тег элемента в схеме: vt:array.
VTBlob	Двоичный BLOB-объект. Представляет следующий тег элемента в схеме: vt:blob.
VTBool	Логических. Представляет следующий тег элемента в схеме: vt:bool.
VTBString	Базовая строка. Представляет следующий тег элемента в схеме: vt:bstr.
VTByte	1-байтовое целое число со знаком. Представляет следующий тег элемента в схеме: vt:i1.
VTClassId	Идентификатор класса. Представляет следующий тег элемента в схеме: vt:clsid.
VTClipboardData	Данные буфера обмена. Представляет следующий тег элемента в схеме: vt:cf.
VTCurrency	Валюты. Представляет следующий тег элемента в схеме: vt:cy.
VTDate	Дата и время. Представляет следующий тег элемента в схеме: vt:date.
VTDecimal	Десятичных. Представляет следующий тег элемента в схеме: vt:decimal.
VTDouble	8-байтовое реальное число. Представляет следующий тег элемента в схеме: vt:r8.
VTEmpty	empty Представляет следующий тег элемента в схеме: vt:empty.
VTError	Код состояния ошибки. Представляет следующий тег элемента в схеме: vt:error.
VTFileTime	Время файла. Представляет следующий тег элемента в схеме: vt:filetime.
VTFloat	4-байтовое реальное число. Представляет следующий тег элемента в схеме: vt:r4.
VTInt32	4-байтовое целое число со знаком. Представляет следующий тег элемента в схеме: vt:i4.
VTInt64	8-байтовое целое число со знаком. Представляет следующий тег элемента в схеме: vt:i8.
VTInteger	Целое число. Представляет следующий тег элемента в схеме: vt:int.
VTLPSTR	LPSTR. Представляет следующий тег элемента в схеме: vt:lpstr.
VTLPWSTR	LPWSTR. Представляет следующий тег элемента в схеме: vt:lpwstr.
VTNull	Null. Представляет следующий тег элемента в схеме: vt:null.
VTOBlob	Двоичный объект BLOB-объекта. Представляет следующий тег элемента в схеме: vt:oblob.
VTOStorage	Двоичный объект хранилища. Представляет следующий тег элемента в схеме: vt:ostorage.
VTOStreamData	Двоичный объект Stream. Представляет следующий тег элемента в схеме: vt:ostream.
VTShort	2-байтовое целое число со знаком. Представляет следующий тег элемента в схеме: vt:i2.
VTStorage	Двоичное хранилище. Представляет следующий тег элемента в схеме: vt:storage.
VTStreamData	Двоичный поток. Представляет следующий тег элемента в схеме: vt:stream.
VTUnsignedByte	1-байтовое целое число без знака. Представляет следующий тег элемента в схеме: vt:ui1.
VTUnsignedInt32	4-байтовое целое число без знака. Представляет следующий тег элемента в схеме: vt:ui4.
VTUnsignedInt64	8-байтовое целое число без знака. Представляет следующий тег элемента в схеме: vt:ui8.
VTUnsignedInteger	Целое число без знака. Представляет следующий тег элемента в схеме: vt:uint.
VTUnsignedShort	2-байтовое целое число без знака. Представляет следующий тег элемента в схеме: vt:ui2.
VTVector	Вектор. Представляет следующий тег элемента в схеме: vt:vector.
VTVStreamData	Двоичный поток с версиями. Представляет следующий тег элемента в схеме: vt:vstream.
XmlQualifiedName	Возвращает полное имя текущего элемента. (Унаследовано от OpenXmlElement)
XName	Возвращает полное имя текущего элемента. (Унаследовано от OpenXmlElement)

Методы

AddAnnotation(Object)	Добавляет объект в список заметок текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Добавляет указанный элемент в элемент , если он является известным дочерним элементом. При этом элемент будет добавлен в правильное расположение в соответствии со схемой. (Унаследовано от OpenXmlCompositeElement)
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)	Добавляет указанный элемент в конец списка дочерних узлов текущего элемента. (Унаследовано от OpenXmlCompositeElement)
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)	Вставляет указанный элемент сразу после указанного ссылочного элемента. (Унаследовано от OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Вставляет указанный элемент сразу после текущего элемента. (Унаследовано от OpenXmlElement)
InsertAt<T>(T, Int32)	Вставляет указанный элемент по указанному индексу дочерних элементов текущего элемента. (Унаследовано от OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Вставляет указанный элемент непосредственно перед указанным ссылочным элементом. (Унаследовано от OpenXmlCompositeElement)
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)	Вставляет указанный элемент в начало списка дочерних узлов текущего элемента. (Унаследовано от OpenXmlCompositeElement)
PreviousSibling()	Возвращает элемент OpenXmlElement, который непосредственно предшествует текущему элементу OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
PreviousSibling<T>()	Возвращает элемент OpenXmlElement с указанным типом, который предшествует текущему объекту OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
Remove()	Удаляет текущий элемент из родительского элемента. (Унаследовано от OpenXmlElement)
RemoveAllChildren()	Удаляет все дочерние элементы текущего элемента. (Унаследовано от OpenXmlCompositeElement)
RemoveAllChildren<T>()	Удалите все дочерние элементы текущего элемента типа T. (Унаследовано от OpenXmlElement)
RemoveAnnotations(Type)	Удаляет заметки указанного типа из текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
RemoveAnnotations<T>()	Удаляет заметки с указанным типом из текущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
RemoveAttribute(String, String)	Удаляет атрибут из текущего элемента. (Унаследовано от OpenXmlElement)
RemoveChild<T>(T)	Удаляет указанный дочерний элемент. (Унаследовано от OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Удаляет объявление пространства имен для указанного префикса. Ничего не удаляет, если нет префикса. (Унаследовано от OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Заменяет один из дочерних элементов текущего элемента другим элементом OpenXmlElement. (Унаследовано от OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Задает атрибут заданного элемента. Если атрибут является известным атрибутом, задается значение атрибута. Если атрибут является расширенным атрибутом, в список расширенных атрибутов добавляется openxmlAttribute. (Унаследовано от OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Задает ряд атрибутов элемента . Если атрибут является известным атрибутом, задается значение атрибута. Если атрибут является расширенным атрибутом, в список расширенных атрибутов добавляется openxmlAttribute. (Унаследовано от OpenXmlElement)
WriteTo(XmlWriter)	Сохраняет текущий узел в указанном xmlWriter. (Унаследовано от OpenXmlElement)

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

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