Style Класс

Определение

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

DocumentFormat.OpenXml.Wordprocessing

Сборка:

DocumentFormat.OpenXml.dll

Пакет:

DocumentFormat.OpenXml v3.0.1

Определение стиля.

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

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

public class Style : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Style = class
    inherit OpenXmlCompositeElement

Public Class Style
Inherits OpenXmlCompositeElement

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

Object

OpenXmlElement

OpenXmlCompositeElement

Style

Примеры

В следующем примере кода открывается текстовый файл, содержащий текст, и к первому абзацу применяется стиль "Заголовок 1".

using System;  
using System.Linq;  
using DocumentFormat.OpenXml.Packaging;  
using DocumentFormat.OpenXml.Wordprocessing;  

namespace StyleEx  
{  
    class Program  
    {  
        // Apply the Heading 1 style to a paragraph.  
        static void Main(string[] args)  
        {  
            string fileName = @"C:\users\public\documents\StyleEx.docx";  

            using (WordprocessingDocument document =   
                WordprocessingDocument.Open(fileName, true))  
            {  
                // Get the first paragraph.  
                Paragraph p =  
                    document.MainDocumentPart.Document.Body.Elements<Paragraph>().First();  

                // If the paragraph has no ParagraphProperties objects, create a new one for it.  
                if (p.Elements<ParagraphProperties>().Count() == 0)  
                {  
                    p.PrependChild<ParagraphProperties>(new ParagraphProperties());  
                }  

                // Get the paragraph properties element of the paragraph.  
                ParagraphProperties pPr = p.Elements<ParagraphProperties>().First();  

                // Set the paragraph style ID to "Heading1".  
                pPr.ParagraphStyleId = new ParagraphStyleId() { Val = "Heading1" };                
            }  
        }  
    }  
}  

Imports System.Linq  
Imports DocumentFormat.OpenXml.Wordprocessing  
Imports DocumentFormat.OpenXml.Packaging  

Module Module1  
    ' Apply the Heading 1 style to a paragraph.  
    Sub Main()  
        Dim fileName As String = "C:\Users\Public\Documents\StyleEx.docx"  

        Using doc As WordprocessingDocument = _  
            WordprocessingDocument.Open(fileName, True)  
            ' Get the first paragraph.  
            Dim p As Paragraph = doc.MainDocumentPart.Document.Body.Elements _  
                (Of Paragraph).First()  

            ' If the paragraph has no ParagraphProperties objects, create a new one for it.  
            If p.Elements(Of ParagraphProperties).Count() = 0 Then  
                p.PrependChild(Of ParagraphProperties)(New ParagraphProperties())  
            End If  

            ' Get the paragraph properties element of the paragraph.  
            Dim pPr As ParagraphProperties = p.Elements(Of ParagraphProperties).First()  

            ' Set the paragraph style ID to "Heading1".  
            pPr.ParagraphStyleId = New ParagraphStyleId() With {.Val = "Heading1"}  
        End Using  
    End Sub  
End Module  

Комментарии

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

style (определение стиля)

Этот элемент задает определение одного стиля в документе WordprocessingML. Стиль — это предопределенный набор свойств таблицы, нумеровки, абзаца и (или) символов, которые могут применяться к регионам в документе.

Определение стиля для любого определения стиля можно разделить на три сегмента:

• Общие свойства стиля

• Тип стиля

• Свойства, относящиеся к типу стиля

Общие свойства стиля относятся к набору свойств, которые можно использовать независимо от типа стиля; например, имя стиля, дополнительные псевдонимы для стиля, идентификатор стиля (используется содержимым документа для ссылки на стиль), если стиль скрыт, если стиль заблокирован и т. д.

[Пример. Рассмотрим стиль под названием Заголовок документа следующим образом:

<w:style w:type="paragraph" w:styleId="Heading1">  
  <w:name w:val="Heading 1"/>  
  <w:basedOn w:val="Normal"/>  
  <w:next w:val="Normal"/>  
  <w:link w:val="Heading1Char"/>  
  <w:uiPriority w:val="1"/>  
  <w:qformat/>  
  <w:rsid w:val="00F303CE"/>  
  …</w:style>  

Над сведениями о форматировании, характерными для этого типа стиля, находятся набор общих свойств стиля, которые определяют сведения, общие для всех типов стилей. конец примера

Типы стилей относятся к свойству стиля, которое определяет тип стиля, созданного с помощью этого определения стиля. WordprocessingML поддерживает шесть типов определений стилей по значениям атрибута типа определения стиля:

• Стили абзацев

• Стили символов

• Связанные стили (абзац + символ) [Примечание: выполняется с помощью элемента link (§17.7.4.6). конечная заметка]

• Стили таблиц

• Стили нумеровки

• Свойства абзаца и символа по умолчанию

[Пример. Рассмотрим стиль под названием Заголовок документа следующим образом:

<w:style w:type="paragraph" w:styleId="Heading1">  
  <w:name w:val="heading 1"/>  
  <w:basedOn w:val="Normal"/>  
  <w:next w:val="Normal"/>  
  <w:link w:val="Heading1Char"/>  
  <w:uiPriority w:val="1"/>  
  <w:qformat/>  
  <w:rsid w:val="00F303CE"/>  
  …</w:style>  

Атрибут type имеет значение paragraph, указывающее, что следующее определение стиля является стилем абзаца. конец примера

Свойства, относящиеся к типу стиля , относятся к полезным данным стиля: его сведениям о форматировании, а также к любым свойствам, которые применяются только к такому типу стиля.

[Пример. Рассмотрим стиль таблицы с основным именем Normal Table , определенным следующим образом:

<w:style w:type="table" w:default="1" w:styleId="TableNormal">  
  <w:name w:val="Normal Table"/>  
  …  <w:tblPr>  
    <w:tblInd w:w="0" w:type="dxa"/>  
    <w:tblCellMar>  
      <w:top w:w="0" w:type="dxa"/>  
      <w:left w:w="108" w:type="dxa"/>  
      <w:bottom w:w="0" w:type="dxa"/>  
      <w:right w:w="108" w:type="dxa"/>  
    </w:tblCellMar>  
  </w:tblPr>  
</w:style>  

Элемент tblPr содержит полезные данные форматирования для этого стиля таблицы, который применим только к стилю таблицы. конец примера

Родительские элементы
styles (§17.7.4.18)

Дочерние элементы	Вложенные запросы
псевдонимы (альтернативные имена стилей)	§17.7.4.1
autoRedefine (автоматическое объединение форматирования пользователя в определение стиля)	§17.7.4.2
basedOn (идентификатор родительского стиля)	§17.7.4.3
hidden (Скрыть стиль из пользовательского интерфейса)	§17.7.4.4
link (ссылка на связанный стиль)	§17.7.4.6
заблокировано (стиль не может быть применен)	§17.7.4.7
name (имя основного стиля)	§17.7.4.9
next (стиль для следующего абзаца)	§17.7.4.10
personal (стиль текста сообщения электронной почты)	§17.7.4.11
personalCompose (стиль композиции сообщений электронной почты)	§17.7.4.12
personalReply (стиль ответа сообщения электронной почты)	§17.7.4.13
pPr (свойства абзаца стиля)	§17.7.8.2
qFormat (основной стиль)	§17.7.4.14
rPr (свойства запуска)	§17.7.9.1
rsid (идентификатор редакции для определения стиля)	§17.7.4.15
semiHidden (скрытие стиля из основного пользовательского интерфейса)	§17.7.4.16
tblPr (свойства таблицы стилей)	§17.7.6.4
tblStylePr (свойства условного форматирования таблицы стиля)	§17.7.6.6
tcPr (свойства ячейки таблицы стилей)	§17.7.6.9
trPr (свойства строки таблицы стилей)	§17.7.6.11
uiPriority (необязательный порядок сортировки пользовательского интерфейса)	§17.7.4.19
unhideWhenUsed (удаление свойства Semi-Hidden при использовании стиля)	§17.7.4.20

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

ISO/IEC29500: 2008.

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

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

Свойства

Aliases	Альтернативные имена стилей. Представляет следующий тег элемента в схеме: w:aliases.
AutoRedefine	Автоматическое слияние пользовательского форматирования с определением стиля. Представляет следующий тег элемента в схеме: w:autoRedefine.
BasedOn	Идентификатор родительского стиля. Представляет следующий тег элемента в схеме: w:basedOn.
ChildElements	Возвращает все дочерние узлы текущего элемента. (Унаследовано от OpenXmlElement)
CustomStyle	Стиль User-Defined Представляет следующий атрибут в схеме: w:customStyle
Default	Стиль по умолчанию Представляет следующий атрибут в схеме: w:default
ExtendedAttributes	Возвращает все расширенные атрибуты (атрибуты, не определенные в схеме) текущего элемента. (Унаследовано от OpenXmlElement)
Features	IFeatureCollection Возвращает для текущего элемента. Эта коллекция компонентов будет доступна только для чтения, но будет наследовать компоненты от родительской части и пакета, если они доступны. (Унаследовано от OpenXmlElement)
FirstChild	Получает первый дочерний элемент текущего элемента OpenXmlElement. (Унаследовано от OpenXmlCompositeElement)
HasAttributes	Возвращает значение, указывающее, имеет ли текущий элемент какие-либо атрибуты. (Унаследовано от OpenXmlElement)
HasChildren	Возвращает значение, указывающее, содержит ли текущий элемент какие-либо дочерние элементы. (Унаследовано от OpenXmlCompositeElement)
InnerText	Возвращает или задает объединенные значения текущего узла и всех его дочерних элементов. (Унаследовано от OpenXmlCompositeElement)
InnerXml	Возвращает или задает разметку, представляющую только дочерние узлы текущего узла. (Унаследовано от OpenXmlCompositeElement)
LastChild	Возвращает последний дочерний элемент текущего элемента OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если такого элемента OpenXmlElement нет. (Унаследовано от OpenXmlCompositeElement)
LinkedStyle	Ссылка на связанный стиль. Представляет следующий тег элемента в схеме: w:link.
LocalName	Возвращает локальное имя текущего элемента. (Унаследовано от OpenXmlElement)
Locked	Стиль не может быть применен. Представляет следующий тег элемента в схеме: w:locked.
MCAttributes	Возвращает или задает атрибуты совместимости разметки. Возвращает значение NULL, если для текущего элемента не определены атрибуты совместимости разметки. (Унаследовано от OpenXmlElement)
NamespaceDeclarations	Возвращает все объявления пространства имен, определенные в текущем элементе. Возвращает пустой перечислитель, если нет объявления пространства имен. (Унаследовано от OpenXmlElement)
NamespaceUri	Возвращает универсальный код ресурса (URI) пространства имен текущего элемента. (Унаследовано от OpenXmlElement)
NextParagraphStyle	Стиль для следующего абзаца. Представляет следующий тег элемента в схеме: w:next.
OpenXmlElementContext	Возвращает openXmlElementContext текущего элемента. (Унаследовано от OpenXmlElement)
OuterXml	Возвращает разметку, представляющую текущий элемент и все его дочерние элементы. (Унаследовано от OpenXmlElement)
Parent	Возвращает родительский элемент текущего элемента. (Унаследовано от OpenXmlElement)
Personal	Стиль текста сообщения электронной почты. Представляет следующий тег элемента в схеме: w:personal.
PersonalCompose	Стиль композиции сообщений электронной почты. Представляет следующий тег элемента в схеме: w:personalCompose.
PersonalReply	Стиль ответа сообщения электронной почты. Представляет следующий тег элемента в схеме: w:personalReply.
Prefix	Возвращает префикс пространства имен текущего элемента. (Унаследовано от OpenXmlElement)
PrimaryStyle	Основной стиль. Представляет следующий тег элемента в схеме: w:qFormat.
Rsid	Идентификатор редакции для определения стиля. Представляет следующий тег элемента в схеме: w:rsid.
SemiHidden	Скрыть стиль из основного пользовательского интерфейса. Представляет следующий тег элемента в схеме: w:semiHidden.
StyleHidden	Скрыть стиль из пользовательского интерфейса. Представляет следующий тег элемента в схеме: w:hidden.
StyleId	Идентификатор стиля Представляет следующий атрибут в схеме: w:styleId
StyleName	Имя основного стиля. Представляет следующий тег элемента в схеме: w:name.
StyleParagraphProperties	Свойства абзаца стиля. Представляет следующий тег элемента в схеме: w:pPr.
StyleRunProperties	Запустите свойства. Представляет следующий тег элемента в схеме: w:rPr.
StyleTableCellProperties	Свойства ячейки таблицы стилей. Представляет следующий тег элемента в схеме: w:tcPr.
StyleTableProperties	Свойства таблицы стилей. Представляет следующий тег элемента в схеме: w:tblPr.
TableStyleConditionalFormattingTableRowProperties	Свойства строки таблицы стилей. Представляет следующий тег элемента в схеме: w:trPr.
Type	Тип стиля Представляет следующий атрибут в схеме: w:type
UIPriority	Необязательный порядок сортировки пользовательского интерфейса. Представляет следующий тег элемента в схеме: w:uiPriority.
UnhideWhenUsed	Удалите свойство Semi-Hidden при использовании стиля. Представляет следующий тег элемента в схеме: w:unhideWhenUsed.
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, его полное имя — w:style. (Унаследовано от OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Возвращает перечислитель, который выполняет итерацию по дочерней коллекции. (Унаследовано от OpenXmlElement)