Columns.EqualWidth Property

Equal Column Widths.Represents the attribte in schema: w:equalWidth

Namespace:  DocumentFormat.OpenXml.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
<SchemaAttrAttribute(, "equalWidth")> _
Public Property EqualWidth As OnOffValue
    Get
    Set
'Usage
Dim instance As Columns
Dim value As OnOffValue

value = instance.EqualWidth

instance.EqualWidth = value
[SchemaAttrAttribute(, "equalWidth")]
public OnOffValue EqualWidth { get; set; }

Property Value

Type: DocumentFormat.OpenXml.OnOffValue
Returns EnumValue<T>.

Remarks

The following information from the ECMA International Standard ECMA-376 can be useful when working with this class.

Specifies whether all the text columns in the current section are of equal width.

If this attribute is present and its value is set to true, on, or 1, then all the columns for this text section are of an equal width and are calculated as follows:

  1. Take the width of the page (from margin to margin).

  2. Divide by the number of columns specified in the num attribute.

  3. For each column, leave space after as defined in the space attribute.

  4. The remaining width of each column is the text column width.

If this attribute is present and its value is set to false, off, or 0, then all the columns for this text section are of different widths and are defined by each col element as follows:

  • Each col element defines a single column.

  • Each w attribute defines the text column width.

  • Each space attribute defines the space after the text column.

Consider a section with column information defined as follows:

<w:cols w:num="3" w:space="1440"
  w:equalWidth="1">
  <w:col w:w="2880" w:space="2880" />
  <w:col w:w="2880" w:space="1440" />
  <w:col w:w="2880" />
</w:cols>

This set of columns has an equalWidth value set to 1. Therefore, the col elements are ignored, and there are three equally sized columns (num value of 3), each with 1 inch of space after (space value of 1440 twentieths of a point).

The possible values for this attribute are defined by the ST_OnOff simple type.

See Also

Reference

Columns Class

Columns Members

DocumentFormat.OpenXml.Wordprocessing Namespace