CustomWorkbookViews Class

Custom Workbook Views.When the object is serialized out as xml, its qualified name is x:customWorkbookViews.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Spreadsheet.CustomWorkbookViews

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(CustomWorkbookView))> _
Public Class CustomWorkbookViews _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As CustomWorkbookViews
[ChildElementInfoAttribute(typeof(CustomWorkbookView))]
public class CustomWorkbookViews : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • CustomWorkbookView <x:customWorkbookView>

[ISO/IEC 29500-1 1st Edition]

18.2.4 customWorkbookViews (Custom Workbook Views)

This element defines the collection of custom workbook views that are defined for this workbook. A customWorkbookView is similar in concept to a workbookView (§18.2.30) in that its attributes contain settings related to the way that the workbook should be displayed on a screen by a spreadsheet application.

[Note: Whilst a workbookView is intended to store the way the workbook window should be displayed by a spreadsheet application, customWorkbookView elements are intended to allow the user to switch between a selection of customWorkbookView items defining window and content display options. end note]

A customWorkbookView contains a greater number of settings (e.g., the presence of a formula bar; visibility of hidden data; whether or not to show comments) and is named.

[Example: A workbook which is used by two different departments might contain two customWorkbookView elements – one where the comments and hidden data are not shown, and one where they are. Users might switch between the customWorkbookView items according to the department in which they work. end example]

There is no limit on the number of custom views that can be contained within a SpreadsheetML instance.

[Example:

<customWorkbookViews>
<customWorkbookView name="CustomView"
guid="{CE6681F1-E999-414D-8446-68A031534B57}" maximized="1" xWindow="1"
yWindow="1" windowWidth="1024" windowHeight="547" activeSheetId="1"/>
</customWorkbookViews>

end example]

Parent Elements

workbook (§18.2.27)

Child Elements

Subclause

customWorkbookView (Custom Workbook View)

§18.2.3

[Note: The W3C XML Schema definition of this element’s content model (CT_CustomWorkbookViews) is located in §A.2. 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

CustomWorkbookViews Members

DocumentFormat.OpenXml.Spreadsheet Namespace