StringItem Class

Character Value.When the object is serialized out as xml, its qualified name is x:s.

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

[ChildElementInfoAttribute(typeof(Tuples))]
[ChildElementInfoAttribute(typeof(MemberPropertyIndex))]
public class StringItem : OpenXmlCompositeElement

The following table lists the possible child types:

  • Tuples <x:tpls>

  • MemberPropertyIndex <x:x>


[ISO/IEC 29500-1 1st Edition]

18.10.1.85 s (Character Value)

Represents a character value in a PivotTable.

[Example:


<sharedItems count="2">
<s v="7527 Brook Way"/>
<s v="3310 Harvey Way"/>
</sharedItems>

end example]

Parent Elements

entries (§18.10.1.28); groupItems (§18.10.1.38); r (§18.10.1.77); sharedItems (§18.10.1.90)

Child Elements

Subclause

tpls (Tuples)

§18.10.1.93

x (Member Property Index)

§18.10.1.96

Attributes

Description

b (Bold)

Specifies a boolean value that indicates whether this value contains bold formatting on the OLAP server. This attribute applies to OLAP-based PivotTables only.

A value of 1 or true indicates this value contains bold formatting on the server.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

bc (Background Color)

Specifies the background color for this value that was provided by the OLAP server. This attribute applies to OLAP-based PivotTables only. The color is specified as a HEX value in RGB space.

The possible values for this attribute are defined by the ST_UnsignedIntHex simple type (§18.18.86).

c (Item Caption)

Specifies the caption for the this item.

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

cp (Member Property Count)

Specifies the number of member property values.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

f (Calculated Item)

Specifies a boolean value that indicates whether this is a calculated item value.

A value of 1 or true indicates this item is a calculated value.

A value of 0 or false indicates this item is not a calculated value.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

fc (Foreground Color)

Specifies the foreground color for this value that was provided by the OLAP server. This attribute applies to OLAP-based PivotTables only. The color is specified as a HEX value in RGB space.

The possible values for this attribute are defined by the ST_UnsignedIntHex simple type (§18.18.86).

i (Italic)

Specifies a boolean value that indicates whether the value contains italic formatting on the OLAP server. This attribute applies to OLAP-based PivotTables only.

A value of 1 or true indicates this value contains italic formatting on the server.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

in (Format Index)

Specifies the index to the OLAP serverformat element where the format string for this entry is stored.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

st (Strikethrough)

Specifies a boolean value that indicates whether the value contains strikethrough formatting on the OLAP server. This attribute applies to OLAP-based PivotTables only.

A value of 1 or true indicates this value contains strikethrough formatting on the server.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

u (Unused Item)

Specifies a boolean value that indicates whether this is an unused item. The application marks an item as unused when an item is deleted from the data source. The item and associated metadata are retained in the cache until the threshold for unused items specified in missingItemsLimit is reached.

A value of 1 or true indicates this item is unused.

A value of 0 or false indicates this item is used.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

un (Underline)

Specifies a boolean value that indicates whether the value contains underline formatting on the OLAP server. This attribute applies to OLAP-based PivotTables only.

A value of 1 or true indicates this value contains underline formatting on the server.

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

v (Value)

Specifies the value of the item.

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_String) is located in §A.2. end note]

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show: