TextProperties Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Defines the TextProperties Class.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is x:textPr.

public class TextProperties : DocumentFormat.OpenXml.OpenXmlCompositeElement

type TextProperties = class
    inherit OpenXmlCompositeElement

Public Class TextProperties
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

TextProperties

Remarks

[ISO/IEC 29500-1 1st Edition]

textPr (Text Import Settings)

This element contains all of the text import settings.

[Example: Here's an example of the XML for a text connection:

<connection id="1" name="text data" type="6" refreshedVersion="3" background="1"  saveData="1">  
  <textPr prompt="0" characterSet="437" sourceFile="C:\Desktop\text data.txt"     delimiter="|">  
    <textFields count="5">  
      <textField/>  
      <textField type="text" position="7"/>  
      <textField type="text" position="28"/>  
      <textField position="36"/>  
      <textField type="text" position="41"/>  
    </textFields>  
  </textPr>  
</connection>  

example]

Parent Elements
connection (§18.13.1)

Child Elements	Subclause
textFields (Fields)	§18.13.11

Attributes	Description
characterSet (Character Set)	Name of the character set associated with the text file. Values for this attribute are restricted to the names and aliases listed in the IANA CHARACTER SETS listing found at http://www.iana.org/assignments/character-sets. [Note: When reading this value, if a system does not support a particular character set, the application is allowed to decide what is the best course of fallback action. end note] If this attribute is not present then the codePage attribute are used. The possible values for this attribute are defined by the W3C XML Schema string datatype.
comma (Comma is Delimiter)	Flag indicating whether to treat comma characters as field delimiters. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
consecutive (Consecutive Delimiters)	Flag indicating whether consecutive delimiters should be treated as just one delimiter. If this flag is true than it's possible or even likely that some rows will return more fields than others, and these fields will always fill cells in the worksheet from left to right. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
decimal (Decimal Separator)	The decimal separator character. This and the thousands attribute are used only when data in the text file contains decimal and thousands separators that are different from those used on the computer, due to a different language setting being used. The following table shows the results when you import text into a spreadsheet application using various separators. Numeric results are displayed in the rightmost column. System decimal separator System thousands separator Text file decimal separator value Text file thousands Separator value Text imported Cell value (data type) Period Comma Comma Period 123.123,45 123,123.45 (numeric) Period Comma Comma Comma 123.123,45 123.123,45 (text) Comma Period Comma Period 123,123.45 123,123.45 (numeric) Period Comma Period Comma 123 123.45 123 123.45 (text) Period Comma Period Space 123 123.45 123,123.45 (numeric) Strings values of this attribute are expected to be one character in length. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
delimited (Delimited File)	true if the file is Tab or character delimited. false if the file should be parsed according to fixed length fields. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
delimiter (Custom Delimiter)	User-specified character to be treated as a field delimiter. Only single characters are supported. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
fileType (File Type)	Ignorable attribute with enum value that defined by ST_FileType. Determines the kind of character set to use during import. Only one of fileType and characterSet or codePage shall be specified for a textPr. The possible values for this attribute are defined by the ST_FileType simple type (§18.18.29).
firstRow (First Row)	Indicates at what row of the file to start the data import. All unsignedInt values are permitted, although it's possible that firstRow is higher than the number of rows in the text file, in which case no data is imported. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
prompt (Prompt for File Name)	Flag indicating whether the user wants to be prompted for the file name on refresh. If false, then the user is not prompted. If true or not present, then the user is prompted. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
qualifier (Qualifier)	Character used as the text string qualifier. The possible values for this attribute are defined by the ST_Qualifier simple type (§18.18.61).
semicolon (Semicolon is Delimiter)	Flag indicating whether to treat semicolon characters as field delimiters. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
sourceFile (Source File Name)	Path to the text file to use to import external data. Can be expressed in or system-specific file path notation. [Note: Applications can decide what forms of they support, and whether system-specific file path notations are supported. end note] The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
space (Space is Delimiter)	Flag indicating whether to treat space characters as field delimiters. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
tab (Tab as Delimiter)	Flag indicating whether to treat tab characters as field delimiters. If false, then tabs will not be used as delimiters. If true or not present, then they are used as delimiters. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
thousands (Thousands Separator)	The thousands separator character. This and the decimal attribute are used only when data in the text file contains decimal and thousands separators that are different from those used on the computer, due to a different language setting being used. Please refer to the decimal attribute description above for a Table describing the behavior. Strings values of this attribute are expected to be one character in length. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

[Note: The W3C XML Schema definition of this element’s content model (CT_TextPr) is located in §A.2. end note]

� ISO/IEC29500: 2008.

Constructors

TextProperties()	Initializes a new instance of the TextProperties class.
TextProperties(IEnumerable<OpenXmlElement>)	Initializes a new instance of the TextProperties class with the specified child elements.
TextProperties(OpenXmlElement[])	Initializes a new instance of the TextProperties class with the specified child elements.
TextProperties(String)	Initializes a new instance of the TextProperties class from outer XML.

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
CodePage	codePage Represents the following attribute in the schema: codePage
Comma	comma Represents the following attribute in the schema: comma
Consecutive	consecutive Represents the following attribute in the schema: consecutive
Decimal	decimal Represents the following attribute in the schema: decimal
Delimited	delimited Represents the following attribute in the schema: delimited
Delimiter	delimiter Represents the following attribute in the schema: delimiter
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FileType	fileType Represents the following attribute in the schema: fileType
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
FirstRow	firstRow Represents the following attribute in the schema: firstRow
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
Prompt	prompt Represents the following attribute in the schema: prompt
Qualifier	qualifier Represents the following attribute in the schema: qualifier
Semicolon	semicolon Represents the following attribute in the schema: semicolon
SourceFile	sourceFile Represents the following attribute in the schema: sourceFile
Space	space Represents the following attribute in the schema: space
TabAsDelimiter	tab Represents the following attribute in the schema: tab
TextCharacterSet	characterSet Represents the following attribute in the schema: characterSet
TextFields	TextFields. Represents the following element tag in the schema: x:textFields.
Thousands	thousands Represents the following attribute in the schema: thousands
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element. (Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)