Partager via


ClientData Class

Attached Object Data.When the object is serialized out as xml, its qualified name is xvml:ClientData.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Vml.Spreadsheet.ClientData

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(Anchor))> _
<ChildElementInfoAttribute(GetType(AutoFill))> _
<ChildElementInfoAttribute(GetType(AutoLine))> _
<ChildElementInfoAttribute(GetType(AutoSizePicture))> _
<ChildElementInfoAttribute(GetType(FormulaMacro))> _
<ChildElementInfoAttribute(GetType(HorizontalTextAlignment))> _
<ChildElementInfoAttribute(GetType(VerticalTextAlignment))> _
<ChildElementInfoAttribute(GetType(LockText))> _
<ChildElementInfoAttribute(GetType(JustifyLastLine))> _
<ChildElementInfoAttribute(GetType(SecretEdit))> _
<ChildElementInfoAttribute(GetType(DefaultButton))> _
<ChildElementInfoAttribute(GetType(HelpButton))> _
<ChildElementInfoAttribute(GetType(CancelButton))> _
<ChildElementInfoAttribute(GetType(DismissButton))> _
<ChildElementInfoAttribute(GetType(AcceleratorPrimary))> _
<ChildElementInfoAttribute(GetType(Disabled))> _
<ChildElementInfoAttribute(GetType(CommentRowTarget))> _
<ChildElementInfoAttribute(GetType(CommentColumnTarget))> _
<ChildElementInfoAttribute(GetType(Visible))> _
<ChildElementInfoAttribute(GetType(RowHidden))> _
<ChildElementInfoAttribute(GetType(ColumnHidden))> _
<ChildElementInfoAttribute(GetType(InputValidationType))> _
<ChildElementInfoAttribute(GetType(MultiLine))> _
<ChildElementInfoAttribute(GetType(VerticalScrollBar))> _
<ChildElementInfoAttribute(GetType(ValidIds))> _
<ChildElementInfoAttribute(GetType(FormulaRange))> _
<ChildElementInfoAttribute(GetType(MinDropDownWidth))> _
<ChildElementInfoAttribute(GetType(SelectionEntry))> _
<ChildElementInfoAttribute(GetType(Disable3DForListBoxAndDropDown))> _
<ChildElementInfoAttribute(GetType(SelectionType))> _
<ChildElementInfoAttribute(GetType(MultiSelections))> _
<ChildElementInfoAttribute(GetType(ListBoxCallbackType))> _
<ChildElementInfoAttribute(GetType(ListItem))> _
<ChildElementInfoAttribute(GetType(DropStyle))> _
<ChildElementInfoAttribute(GetType(Colored))> _
<ChildElementInfoAttribute(GetType(DropLines))> _
<ChildElementInfoAttribute(GetType(Checked))> _
<ChildElementInfoAttribute(GetType(FormulaLink))> _
<ChildElementInfoAttribute(GetType(FormulaPicture))> _
<ChildElementInfoAttribute(GetType(Disable3D))> _
<ChildElementInfoAttribute(GetType(FirstButton))> _
<ChildElementInfoAttribute(GetType(FormulaGroup))> _
<ChildElementInfoAttribute(GetType(ScrollBarPosition))> _
<ChildElementInfoAttribute(GetType(ScrollBarMin))> _
<ChildElementInfoAttribute(GetType(ScrollBarMax))> _
<ChildElementInfoAttribute(GetType(ScrollBarIncrement))> _
<ChildElementInfoAttribute(GetType(ScrollBarPageIncrement))> _
<ChildElementInfoAttribute(GetType(HorizontalScrollBar))> _
<ChildElementInfoAttribute(GetType(ScrollBarWidth))> _
<ChildElementInfoAttribute(GetType(MapOcxControl))> _
<ChildElementInfoAttribute(GetType(ClipboardFormat))> _
<ChildElementInfoAttribute(GetType(CameraObject))> _
<ChildElementInfoAttribute(GetType(RecalculateAlways))> _
<ChildElementInfoAttribute(GetType(AutoScaleFont))> _
<ChildElementInfoAttribute(GetType(DdeObject))> _
<ChildElementInfoAttribute(GetType(UIObject))> _
<ChildElementInfoAttribute(GetType(ScriptText))> _
<ChildElementInfoAttribute(GetType(ScriptExtended))> _
<ChildElementInfoAttribute(GetType(PrintObject))> _
<ChildElementInfoAttribute(GetType(ScriptLocation))> _
<ChildElementInfoAttribute(GetType(FormulaTextBox))> _
<ChildElementInfoAttribute(GetType(AcceleratorSecondary))> _
<ChildElementInfoAttribute(GetType(ScriptLanguage))> _
<ChildElementInfoAttribute(GetType(MoveWithCells))> _
<ChildElementInfoAttribute(GetType(ResizeWithCells))> _
<ChildElementInfoAttribute(GetType(Locked))> _
<ChildElementInfoAttribute(GetType(DefaultSize))> _
Public Class ClientData _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As ClientData
[ChildElementInfoAttribute(typeof(Anchor))]
[ChildElementInfoAttribute(typeof(AutoFill))]
[ChildElementInfoAttribute(typeof(AutoLine))]
[ChildElementInfoAttribute(typeof(AutoSizePicture))]
[ChildElementInfoAttribute(typeof(FormulaMacro))]
[ChildElementInfoAttribute(typeof(HorizontalTextAlignment))]
[ChildElementInfoAttribute(typeof(VerticalTextAlignment))]
[ChildElementInfoAttribute(typeof(LockText))]
[ChildElementInfoAttribute(typeof(JustifyLastLine))]
[ChildElementInfoAttribute(typeof(SecretEdit))]
[ChildElementInfoAttribute(typeof(DefaultButton))]
[ChildElementInfoAttribute(typeof(HelpButton))]
[ChildElementInfoAttribute(typeof(CancelButton))]
[ChildElementInfoAttribute(typeof(DismissButton))]
[ChildElementInfoAttribute(typeof(AcceleratorPrimary))]
[ChildElementInfoAttribute(typeof(Disabled))]
[ChildElementInfoAttribute(typeof(CommentRowTarget))]
[ChildElementInfoAttribute(typeof(CommentColumnTarget))]
[ChildElementInfoAttribute(typeof(Visible))]
[ChildElementInfoAttribute(typeof(RowHidden))]
[ChildElementInfoAttribute(typeof(ColumnHidden))]
[ChildElementInfoAttribute(typeof(InputValidationType))]
[ChildElementInfoAttribute(typeof(MultiLine))]
[ChildElementInfoAttribute(typeof(VerticalScrollBar))]
[ChildElementInfoAttribute(typeof(ValidIds))]
[ChildElementInfoAttribute(typeof(FormulaRange))]
[ChildElementInfoAttribute(typeof(MinDropDownWidth))]
[ChildElementInfoAttribute(typeof(SelectionEntry))]
[ChildElementInfoAttribute(typeof(Disable3DForListBoxAndDropDown))]
[ChildElementInfoAttribute(typeof(SelectionType))]
[ChildElementInfoAttribute(typeof(MultiSelections))]
[ChildElementInfoAttribute(typeof(ListBoxCallbackType))]
[ChildElementInfoAttribute(typeof(ListItem))]
[ChildElementInfoAttribute(typeof(DropStyle))]
[ChildElementInfoAttribute(typeof(Colored))]
[ChildElementInfoAttribute(typeof(DropLines))]
[ChildElementInfoAttribute(typeof(Checked))]
[ChildElementInfoAttribute(typeof(FormulaLink))]
[ChildElementInfoAttribute(typeof(FormulaPicture))]
[ChildElementInfoAttribute(typeof(Disable3D))]
[ChildElementInfoAttribute(typeof(FirstButton))]
[ChildElementInfoAttribute(typeof(FormulaGroup))]
[ChildElementInfoAttribute(typeof(ScrollBarPosition))]
[ChildElementInfoAttribute(typeof(ScrollBarMin))]
[ChildElementInfoAttribute(typeof(ScrollBarMax))]
[ChildElementInfoAttribute(typeof(ScrollBarIncrement))]
[ChildElementInfoAttribute(typeof(ScrollBarPageIncrement))]
[ChildElementInfoAttribute(typeof(HorizontalScrollBar))]
[ChildElementInfoAttribute(typeof(ScrollBarWidth))]
[ChildElementInfoAttribute(typeof(MapOcxControl))]
[ChildElementInfoAttribute(typeof(ClipboardFormat))]
[ChildElementInfoAttribute(typeof(CameraObject))]
[ChildElementInfoAttribute(typeof(RecalculateAlways))]
[ChildElementInfoAttribute(typeof(AutoScaleFont))]
[ChildElementInfoAttribute(typeof(DdeObject))]
[ChildElementInfoAttribute(typeof(UIObject))]
[ChildElementInfoAttribute(typeof(ScriptText))]
[ChildElementInfoAttribute(typeof(ScriptExtended))]
[ChildElementInfoAttribute(typeof(PrintObject))]
[ChildElementInfoAttribute(typeof(ScriptLocation))]
[ChildElementInfoAttribute(typeof(FormulaTextBox))]
[ChildElementInfoAttribute(typeof(AcceleratorSecondary))]
[ChildElementInfoAttribute(typeof(ScriptLanguage))]
[ChildElementInfoAttribute(typeof(MoveWithCells))]
[ChildElementInfoAttribute(typeof(ResizeWithCells))]
[ChildElementInfoAttribute(typeof(Locked))]
[ChildElementInfoAttribute(typeof(DefaultSize))]
public class ClientData : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • MoveWithCells <xvml:MoveWithCells>

  • ResizeWithCells <xvml:SizeWithCells>

  • Anchor <xvml:Anchor>

  • Locked <xvml:Locked>

  • DefaultSize <xvml:DefaultSize>

  • PrintObject <xvml:PrintObject>

  • Disabled <xvml:Disabled>

  • AutoFill <xvml:AutoFill>

  • AutoLine <xvml:AutoLine>

  • AutoSizePicture <xvml:AutoPict>

  • FormulaMacro <xvml:FmlaMacro>

  • HorizontalTextAlignment <xvml:TextHAlign>

  • VerticalTextAlignment <xvml:TextVAlign>

  • LockText <xvml:LockText>

  • JustifyLastLine <xvml:JustLastX>

  • SecretEdit <xvml:SecretEdit>

  • DefaultButton <xvml:Default>

  • HelpButton <xvml:Help>

  • CancelButton <xvml:Cancel>

  • DismissButton <xvml:Dismiss>

  • AcceleratorPrimary <xvml:Accel>

  • AcceleratorSecondary <xvml:Accel2>

  • CommentRowTarget <xvml:Row>

  • CommentColumnTarget <xvml:Column>

  • Visible <xvml:Visible>

  • RowHidden <xvml:RowHidden>

  • ColumnHidden <xvml:ColHidden>

  • InputValidationType <xvml:VTEdit>

  • MultiLine <xvml:MultiLine>

  • VerticalScrollBar <xvml:VScroll>

  • ValidIds <xvml:ValidIds>

  • FormulaRange <xvml:FmlaRange>

  • MinDropDownWidth <xvml:WidthMin>

  • SelectionEntry <xvml:Sel>

  • Disable3DForListBoxAndDropDown <xvml:NoThreeD2>

  • SelectionType <xvml:SelType>

  • MultiSelections <xvml:MultiSel>

  • ListBoxCallbackType <xvml:LCT>

  • ListItem <xvml:ListItem>

  • DropStyle <xvml:DropStyle>

  • Colored <xvml:Colored>

  • DropLines <xvml:DropLines>

  • Checked <xvml:Checked>

  • FormulaLink <xvml:FmlaLink>

  • FormulaPicture <xvml:FmlaPict>

  • Disable3D <xvml:NoThreeD>

  • FirstButton <xvml:FirstButton>

  • FormulaGroup <xvml:FmlaGroup>

  • ScrollBarPosition <xvml:Val>

  • ScrollBarMin <xvml:Min>

  • ScrollBarMax <xvml:Max>

  • ScrollBarIncrement <xvml:Inc>

  • ScrollBarPageIncrement <xvml:Page>

  • HorizontalScrollBar <xvml:Horiz>

  • ScrollBarWidth <xvml:Dx>

  • MapOcxControl <xvml:MapOCX>

  • ClipboardFormat <xvml:CF>

  • CameraObject <xvml:Camera>

  • RecalculateAlways <xvml:RecalcAlways>

  • AutoScaleFont <xvml:AutoScale>

  • DdeObject <xvml:DDE>

  • UIObject <xvml:UIObj>

  • ScriptText <xvml:ScriptText>

  • ScriptExtended <xvml:ScriptExtended>

  • ScriptLanguage <xvml:ScriptLanguage>

  • ScriptLocation <xvml:ScriptLocation>

  • FormulaTextBox <xvml:FmlaTxbx>

[ISO/IEC 29500-1 1st Edition]

14.4.2.12 ClientData (Attached Object Data)

This element specifies data associated with objects attached to a spreadsheet. While this element might contain any of the child elements below, only certain combinations are meaningful. The ObjectType attribute determines the kind of object the element represents and which subset of child elements is appropriate. Relevant groups are identified for each child element.

[Example: The following defines additional information for a comment. Its edges are anchored to the first and fourth rows and the second and fourth columns. It points to the cell in the first row, first column.

<x:ClientData ObjectType="Note">
<x:MoveWithCells/>
<x:SizeWithCells/>
<x:Anchor>1, 15, 0, 2, 3, 15, 3, 16</x:Anchor>
<x:AutoFill>False</x:AutoFill>
<x:Row>0</x:Row>
<x:Column>0</x:Column>
<x:Visible/>
</x:ClientData>

end example]

[Example: The following defines additional information for a radio button. It is the first in a series of radio buttons and selected by default. The accelerator key is 'A' (65 is the decimal value for 'A' (U+0041)) and it is linked to the cell at column A, row 1 of the first sheet.

<x:ClientData ObjectType=3D"Radio">
<x:SizeWithCells/>
<x:AutoFill>False</x:AutoFill>
<x:AutoLine>False</x:AutoLine>
<x:TextVAlign>Center</x:TextVAlign>
<x:Checked>1</x:Checked>
<x:Accel>65</x:Accel>
<x:FmlaLink>Sheet1!$A$1</x:FmlaLink>
<x:FirstButton/>
</x:ClientData>

end example]

Parent Elements

arc (§14.1.2.1); curve (§14.1.2.3); group (§14.1.2.7); image (§14.1.2.10); line (§14.1.2.12); oval (§14.1.2.13); polyline (§14.1.2.15); rect (§14.1.2.16); roundrect (§14.1.2.17); shape (§14.1.2.19); shapetype (§14.1.2.20)

Child Elements

Subclause

Accel (Primary Keyboard Accelerator)

§14.4.2.1

Accel2 (Secondary Keyboard Accelerator)

§14.4.2.2

Anchor (Anchor)

§14.4.2.3

AutoFill (AutoFill)

§14.4.2.4

AutoLine (AutoLine)

§14.4.2.5

AutoPict (Automatically Size)

§14.4.2.6

AutoScale (Font AutoScale)

§14.4.2.7

Camera (Camera Tool)

§14.4.2.8

Cancel (Cancel Button)

§14.4.2.9

CF (Clipboard Format)

§14.4.2.10

Checked (Checked)

§14.4.2.11

ColHidden (Comment's Column is Hidden)

§14.4.2.13

Colored (Dropdown Color Toggle)

§14.4.2.14

Column (Comment Column Target)

§14.4.2.15

DDE (Dynamic Data Exchange)

§14.4.2.16

Default (Default Button)

§14.4.2.17

DefaultSize (Default Size Toggle)

§14.4.2.18

Disabled (Macro Disable Toggle)

§14.4.2.19

Dismiss (Dismiss Button)

§14.4.2.20

DropLines (Dropdown Maximum Lines)

§14.4.2.21

DropStyle (Dropdown Style)

§14.4.2.22

Dx (Scroll Bar Width)

§14.4.2.23

FirstButton (First Radio Button)

§14.4.2.24

FmlaGroup (Linked Formula - Group Box)

§14.4.2.25

FmlaLink (Linked Formula)

§14.4.2.26

FmlaMacro (Reference to Custom Function)

§14.4.2.27

FmlaPict (Camera Source Range)

§14.4.2.28

FmlaRange (List Items Source Range)

§14.4.2.29

FmlaTxbx (Text Formula)

§14.4.2.30

Help (Help Button)

§14.4.2.31

Horiz (Scroll Bar Orientation)

§14.4.2.32

Inc (Scroll Bar Increment)

§14.4.2.33

JustLastX (Far East Alignment Toggle)

§14.4.2.34

LCT (Callback Type)

§14.4.2.35

ListItem (Non-linked List Item)

§14.4.2.36

Locked (Lock Toggle)

§14.4.2.37

LockText (Text Lock)

§14.4.2.38

MapOCX (Embedded Control)

§14.4.2.39

Max (Scroll Bar Maximum)

§14.4.2.40

Min (Scroll Bar Minimum)

§14.4.2.41

MoveWithCells (Move with Cells)

§14.4.2.42

MultiLine (Multi-line)

§14.4.2.43

MultiSel (Multiple Selections)

§14.4.2.44

NoThreeD (Disable 3D)

§14.4.2.45

NoThreeD2 (Disable 3D)

§14.4.2.46

Page (Scroll Bar Page Increment)

§14.4.2.47

PrintObject (Print Toggle)

§14.4.2.48

RecalcAlways (Recalculation Toggle)

§14.4.2.49

Row (Comment Row Target)

§14.4.2.50

RowHidden (Comment's Row is Hidden)

§14.4.2.51

ScriptExtended (HTML Script Attributes)

§14.4.2.52

ScriptLanguage (HTML Script Language)

§14.4.2.53

ScriptLocation (HTML Script Location)

§14.4.2.54

ScriptText (HTML Script Text)

§14.4.2.55

SecretEdit (Password Edit)

§14.4.2.56

Sel (Selected Entry)

§14.4.2.57

SelType (Selection Type)

§14.4.2.58

SizeWithCells (Resize with Cells)

§14.4.2.59

TextHAlign (Horizontal Text Alignment)

§14.4.2.60

TextVAlign (Vertical Text Alignment)

§14.4.2.61

UIObj (UI Object Toggle)

§14.4.2.62

Val (Scroll bar position)

§14.4.2.63

ValidIds (Valid ID)

§14.4.2.64

Visible (Comment Visibility Toggle)

§14.4.2.65

VScroll (Vertical Scroll)

§14.4.2.66

VTEdit (Validation Type)

§14.4.2.67

WidthMin (Minimum Width)

§14.4.2.68

Attributes

Description

ObjectType (Object type)

  • Specifies the kind of the object. Different sets of child elements are appropriate for different types of objects.

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

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

© ISO/IEC29500: 2008.

Thread Safety

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

See Also

Reference

ClientData Members

DocumentFormat.OpenXml.Vml.Spreadsheet Namespace