TableProperties Класс

Определение

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

DocumentFormat.OpenXml.Wordprocessing

Сборка:

DocumentFormat.OpenXml.dll

Пакет:

DocumentFormat.OpenXml v3.0.1

Свойства таблицы.

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

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

public class TableProperties : DocumentFormat.OpenXml.OpenXmlCompositeElement

type TableProperties = class
    inherit OpenXmlCompositeElement

Public Class TableProperties
Inherits OpenXmlCompositeElement

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

Object

OpenXmlElement

OpenXmlCompositeElement

TableProperties

Примеры

В следующем примере кода класс используется TableProperties для создания таблицы и указания сведений о ее границе.

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

namespace TablePropertiesEx  
{  
    class Program  
    {  
        // Insert a table into an existing word processing document.  
        static void Main(string[] args)  
        {  
            string fileName = @"C:\users\public\documents\TablePropertiesEx.docx";  
            using (WordprocessingDocument document  
                = WordprocessingDocument.Open(fileName, true))  
            {  
                // Create an empty table.  
                Table table = new Table();  

                // Create a TableProperties object and specify its border information.  
                TableProperties tableProperties = new TableProperties(  
                    new TableBorders(new TopBorder() { Val = new EnumValue<BorderValues>(BorderValues.Birds), Size = 24 },  
                        new BottomBorder() { Val = new EnumValue<BorderValues>(BorderValues.Birds), Size = 24 },  
                        new LeftBorder() { Val = new EnumValue<BorderValues>(BorderValues.Birds), Size = 24 },  
                        new RightBorder() { Val = new EnumValue<BorderValues>(BorderValues.Birds), Size = 24 },  
                        new InsideHorizontalBorder() { Val = new EnumValue<BorderValues>(BorderValues.Birds), Size = 24 },  
                        new InsideVerticalBorder() { Val = new EnumValue<BorderValues>(BorderValues.Birds), Size = 24 })  
                );  

                // Append the TableProperties object to the empty table.  
                table.AppendChild<TableProperties>(tableProperties);  

                // Create a row and a cell.  
                TableRow tableRow = new TableRow();  
                TableCell tableCell1 = new TableCell();  

                // Specify the width property of the table cell.  
                tableCell1.Append(new TableCellProperties(  
                    new TableCellWidth() { Type = TableWidthUnitValues.Dxa, Width = "2400" }));  

                // Write some text in the cell.  
                tableCell1.Append(new Paragraph(new Run(new Text("Some cell text."))));  

                // Append the cell to the row.  
                tableRow.Append(tableCell1);  

                // Create a second table cell by copying the OuterXml value of the first table cell.  
                TableCell tableCell2 = new TableCell(tableCell1.OuterXml);  

                // Append the cell to the row.  
                tableRow.Append(tableCell2);  

                // Append the table row to the table.  
                table.Append(tableRow);  

                // Append the table to the document.  
                document.MainDocumentPart.Document.Body.Append(table);  

                Console.WriteLine("The table has been created.\nPress a key.");  
                Console.ReadKey();  
            }  
        }  
    }  
}  

Imports DocumentFormat.OpenXml  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Wordprocessing  

Module Module1  
    ' Insert a table into an existing word processing document.  
    Sub Main(ByVal args As String())  
        Dim fileName As String = "C:\users\public\documents\TablePropertiesEx.docx"  
        Using document As WordprocessingDocument = WordprocessingDocument.Open(fileName, True)  
            ' Create an empty table.  
            Dim table As New Table()  

            ' Create a TableProperties object and specify its border information.  
            Dim tableProperties As New TableProperties(New TableBorders(New TopBorder() With { _  
             .Val = New EnumValue(Of BorderValues)(BorderValues.Birds), _  
             .Size = 24 _  
            }, New BottomBorder() With { _  
             .Val = New EnumValue(Of BorderValues)(BorderValues.Birds), _  
             .Size = 24 _  
            }, New LeftBorder() With { _  
             .Val = New EnumValue(Of BorderValues)(BorderValues.Birds), _  
             .Size = 24 _  
            }, New RightBorder() With { _  
             .Val = New EnumValue(Of BorderValues)(BorderValues.Birds), _  
             .Size = 24 _  
            }, New InsideHorizontalBorder() With { _  
             .Val = New EnumValue(Of BorderValues)(BorderValues.Birds), _  
             .Size = 24 _  
            }, New InsideVerticalBorder() With { _  
             .Val = New EnumValue(Of BorderValues)(BorderValues.Birds), _  
             .Size = 24 _  
            }))  

            ' Append the TableProperties object to the empty table.  
            table.AppendChild(Of TableProperties)(tableProperties)  

            ' Create a row and a cell.  
            Dim tableRow As New TableRow()  
            Dim tableCell1 As New TableCell()  

            ' Specify the width property of the table cell.  
            tableCell1.Append(New TableCellProperties(New TableCellWidth() With { _  
             .Type = TableWidthUnitValues.Dxa, _  
             .Width = "2400" _  
            }))  

            ' Write some text in the cell.  
            tableCell1.Append(New Paragraph(New Run(New Text("Some cell text."))))  

            ' Append the cell to the row.  
            tableRow.Append(tableCell1)  

            ' Create a second table cell by copying the OuterXml value of the first table cell.  
            Dim tableCell2 As New TableCell(tableCell1.OuterXml)  

            ' Append the cell to the row.  
            tableRow.Append(tableCell2)  

            ' Append the table row to the table.  
            table.Append(tableRow)  

            ' Append the table to the document.  
            document.MainDocumentPart.Document.Body.Append(table)  

            Console.WriteLine("The table has been created." & vbLf & "Press a key.")  
            Console.ReadKey()  
        End Using  
    End Sub  
End Module  

Комментарии

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

tblPr (свойства таблицы)

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

[Пример. Рассмотрим следующую простую таблицу WordprocessingML:

Эта таблица определяет одну точку для всех типов границ и имеет значение 100 % ширины страницы — оба свойства для всей таблицы. Результирующая таблица представлена следующим wordprocessingML:

<w:tbl>  
  <w:tblPr>  
    <w:tblW w:w="0" w:type="auto"/>  
    <w:tblBorders>  
      <w:top w:val="single" w:sz="4" w:space="0" w:color="auto"/>  
      <w:left w:val="single" w:sz="4" w:space="0" w:color="auto"/>  
      <w:bottom w:val="single" w:sz="4" w:space="0" w:color="auto"/>  
      <w:right w:val="single" w:sz="4" w:space="0" w:color="auto"/>  
      <w:insideH w:val="single" w:sz="4" w:space="0" w:color="auto"/>  
      <w:insideV w:val="single" w:sz="4" w:space="0" w:color="auto"/>  
    </w:tblBorders>  
  </w:tblPr>  
  …</w:tbl>  

В этом примере элемент tblW (§17.4.64) определяет общую ширину таблицы, для которой в данном случае задается тип auto, который указывает, что размер таблицы должен автоматически соответствовать ее содержимому. Элемент tblBorders (§17.4.39) указывает каждую из границ таблицы и одну точку границы на верхней, левой, нижней, правой и горизонтальной и вертикальной границах. конец примера

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

Дочерние элементы	Вложенные запросы
bidiVisual (визуально справа налево)	§17.4.1
jc (выравнивание таблицы)	§17.4.29
shd (затенение таблиц)	§17.4.32
tblBorders (границы таблиц)	§17.4.39
tblCaption (заголовок таблицы)	§17.4.41
tblCellMar (значения по умолчанию поля ячейки таблицы)	§17.4.43
tblCellSpacing (интервал между ячейками таблицы по умолчанию)	§17.4.46
tblDescription (описание таблицы)	§17.4.47
tblInd (отступ таблицы от начального поля)	§17.4.51
tblLayout (макет таблицы)	§17.4.53
tblLook (параметры условного форматирования стиля таблицы)	§17.4.56
tblOverlap (плавающая таблица позволяет перекрывать другие таблицы)	§17.4.57
tblpPr (размещение с плавающей таблицей)	§17.4.58
tblPrChange (сведения о редакции свойств таблицы)	§17.13.5.34
tblStyle (стиль таблицы, на который ссылается ссылка)	§17.4.63
tblStyleColBandSize (число столбцов в полосе столбцов)	§17.7.6.5
tblStyleRowBandSize (количество строк в диапазоне строк)	§17.7.6.7
tblW (предпочтительная ширина таблицы)	§17.4.64

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

ISO/IEC29500: 2008.

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

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

Свойства

BiDiVisual	BiDiVisual. Представляет следующий тег элемента в схеме: w:bidiVisual.
ChildElements	Возвращает все дочерние узлы текущего элемента. (Унаследовано от OpenXmlElement)
ExtendedAttributes	Возвращает все расширенные атрибуты (атрибуты, не определенные в схеме) текущего элемента. (Унаследовано от OpenXmlElement)
Features	IFeatureCollection Возвращает для текущего элемента. Эта коллекция компонентов будет доступна только для чтения, но будет наследовать компоненты от родительской части и пакета, если они доступны. (Унаследовано от OpenXmlElement)
FirstChild	Получает первый дочерний элемент текущего элемента OpenXmlElement. (Унаследовано от OpenXmlCompositeElement)
HasAttributes	Возвращает значение, указывающее, имеет ли текущий элемент какие-либо атрибуты. (Унаследовано от OpenXmlElement)
HasChildren	Возвращает значение, указывающее, содержит ли текущий элемент какие-либо дочерние элементы. (Унаследовано от OpenXmlCompositeElement)
InnerText	Возвращает или задает объединенные значения текущего узла и всех его дочерних элементов. (Унаследовано от OpenXmlCompositeElement)
InnerXml	Возвращает или задает разметку, представляющую только дочерние узлы текущего узла. (Унаследовано от OpenXmlCompositeElement)
LastChild	Возвращает последний дочерний элемент текущего элемента OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если такого элемента OpenXmlElement нет. (Унаследовано от OpenXmlCompositeElement)
LocalName	Возвращает локальное имя текущего элемента. (Унаследовано от OpenXmlElement)
MCAttributes	Возвращает или задает атрибуты совместимости разметки. Возвращает значение NULL, если для текущего элемента не определены атрибуты совместимости разметки. (Унаследовано от OpenXmlElement)
NamespaceDeclarations	Возвращает все объявления пространства имен, определенные в текущем элементе. Возвращает пустой перечислитель, если нет объявления пространства имен. (Унаследовано от OpenXmlElement)
NamespaceUri	Возвращает универсальный код ресурса (URI) пространства имен текущего элемента. (Унаследовано от OpenXmlElement)
OpenXmlElementContext	Возвращает openXmlElementContext текущего элемента. (Унаследовано от OpenXmlElement)
OuterXml	Возвращает разметку, представляющую текущий элемент и все его дочерние элементы. (Унаследовано от OpenXmlElement)
Parent	Возвращает родительский элемент текущего элемента. (Унаследовано от OpenXmlElement)
Prefix	Возвращает префикс пространства имен текущего элемента. (Унаследовано от OpenXmlElement)
Shading	Затенения. Представляет следующий тег элемента в схеме: w:shd.
TableBorders	TableBorders. Представляет следующий тег элемента в схеме: w:tblBorders.
TableCaption	TableCaption, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий тег элемента в схеме: w:tblCaption.
TableCellMarginDefault	TableCellMarginDefault. Представляет следующий тег элемента в схеме: w:tblCellMar.
TableCellSpacing	TableCellSpacing. Представляет следующий тег элемента в схеме: w:tblCellSpacing.
TableDescription	TableDescription, это свойство доступно только в Office 2010 и более поздних версиях. Представляет следующий тег элемента в схеме: w:tblDescription.
TableIndentation	TableIndentation. Представляет следующий тег элемента в схеме: w:tblInd.
TableJustification	TableJustification. Представляет следующий тег элемента в схеме: w:jc.
TableLayout	TableLayout. Представляет следующий тег элемента в схеме: w:tblLayout.
TableLook	TableLook. Представляет следующий тег элемента в схеме: w:tblLook.
TableOverlap	TableOverlap. Представляет следующий тег элемента в схеме: w:tblOverlap.
TablePositionProperties	TablePositionProperties. Представляет следующий тег элемента в схеме: w:tblpPr.
TablePropertiesChange	Сведения о редакции для свойств таблицы. Представляет следующий тег элемента в схеме: w:tblPrChange.
TableStyle	Тблстиль. Представляет следующий тег элемента в схеме: w:tblStyle.
TableWidth	TableWidth. Представляет следующий тег элемента в схеме: w:tblW.
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:tblPr. (Унаследовано от OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Возвращает перечислитель, который выполняет итерацию по дочерней коллекции. (Унаследовано от OpenXmlElement)