ScrollbarVisibility Class
Scrollbar Display Option.When the object is serialized out as xml, its qualified name is w:scrollbar.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Wordprocessing.ScrollbarVisibility
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class ScrollbarVisibility _
Inherits OpenXmlLeafElement
'Usage
Dim instance As ScrollbarVisibility
public class ScrollbarVisibility : OpenXmlLeafElement
Remarks
[ISO/IEC 29500-1 1st Edition]
17.15.2.38 scrollbar (Scrollbar Display Option)
This element specifies when a scrollbar shall be visible for the contents of the current frame. When this element is set, the val attribute determines exactly when the scrollbar shall be visible. This property is analogous to the scrolling attribute on the frame element in HTML.
If this element is omitted, the scrollbar shall only be displayed when the contents of the frame exceed the visible space for the frame (i.e. when the scrollbar is needed to display all of the content).
[Example: Consider a WordprocessingML document which serves as the frameset container for a frameset consisting of the following three frames:
.jpg "DocumentFormat.OpenXml.Wordprocessing.ScrollbarVis")
The frameset properties for this document are specified by the following WordprocessingML within the web page settings:
<w:frameset>
…
<w:frameset>
…
<w:frame>
<w:name w:val="Frame 2" />
<w:scrollbar w:val="auto" />
</w:frame>
…
</w:frameset>
</w:frameset>
The scrollbar element has a val attribute of auto, which specifies that the frame must only display a scrollbar when it is needed to display all of its content. end example]
Parent Elements |
|---|
frame (§17.15.2.16) |
Attributes |
Description |
|---|---|
val (Scrollbar Display Option Value) |
Specifies the criteria under which a scrollbar shall be displayed along with the contents of this frameset, as defined by the simple type referenced below. [Example: Consider a frameset definition within a WordprocessingML document which defines the following scrollbar visibility setting: <w:frame> <w:scrollbar w:val="on" /> … </w:frame> The val attribute value of on specifies that the scrollbar must always be displayed, even when it is not needed (i.e. when it would be displayed disabled). end example] The possible values for this attribute are defined by the ST_FrameScrollbar simple type (§17.18.32). |
[Note: The W3C XML Schema definition of this element’s content model (CT_FrameScrollbar) is located in §A.1. 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.