Frameset Class

Root Frameset Definition.When the object is serialized out as xml, its qualified name is w:frameset.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Wordprocessing.Frameset

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(FrameSize))> _
<ChildElementInfoAttribute(GetType(FrameLayout))> _
<ChildElementInfoAttribute(GetType(FramesetSplitbar))> _
<ChildElementInfoAttribute(GetType(Frame))> _
<ChildElementInfoAttribute(GetType(Frameset))> _
Public Class Frameset _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As Frameset

[ChildElementInfoAttribute(typeof(FrameSize))]
[ChildElementInfoAttribute(typeof(FrameLayout))]
[ChildElementInfoAttribute(typeof(FramesetSplitbar))]
[ChildElementInfoAttribute(typeof(Frame))]
[ChildElementInfoAttribute(typeof(Frameset))]
public class Frameset : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

• FrameSize <w:sz>

• FramesetSplitbar <w:framesetSplitbar>

• FrameLayout <w:frameLayout>

• Frameset <w:frameset>

• Frame <w:frame>

[ISO/IEC 29500-1 1st Edition]

17.15.2.18 frameset (Nested Frameset Definition)

This element specifies a frameset which has been nested within another frameset within a WordprocessingML document. This WordprocessingML element is analogous to the frameset element in HTML (when that frameset is the child of another frameset element).

[Example: Consider a WordprocessingML document which serves as the frameset container for a frameset consisting of the following three frames:

The frameset properties for this document are specified by the following WordprocessingML within the web page settings:

<w:frameset>
  <w:frameLayout w:val="rows" />
  <w:frame>
    …
  </w:frame>
  <w:frameset>
    <w:frameLayout w:val="cols" />
    <w:frame>
      …
    </w:frame>
    <w:frame>
      …
    </w:frame>
  </w:frameset>
</w:frameset>

The child frameset element specifies the frameset definition for the inner frameset; that frameset consists of two frames (Frame 2 and Frame 3 in the image above) which have been laid out horizontally as columns. end example]

Parent Elements
frameset (§17.15.2.18); frameset (§17.15.2.19)

Child Elements	Subclause
frame (Single Frame Properties)	§17.15.2.16
frameLayout (Frameset Layout)	§17.15.2.17
frameset (Nested Frameset Definition)	§17.15.2.18
framesetSplitbar (Frameset Splitter Properties)	§17.15.2.20
sz (Nested Frameset Size)	§17.15.2.41
title (Frame or Frameset Title)	§17.15.2.43

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

[ISO/IEC 29500-1 1st Edition]

17.15.2.19 frameset (Root Frameset Definition)

This element specifies that this document is the container for a frameset. This WordprocessingML element is analogous to the frameset element in HTML.

When the frameset element is present within a document, that document shall serve as a frameset definition only; all of its normal document content shall therefore not be displayed as long as it contains at least one child frame or frameset element.

If this element is omitted, then the currently document shall not be treated as a frameset definition; its regular document content shall be displayed.

[Example: Consider a WordprocessingML document which serves as the frameset container for a frameset consisting of the following three frames:

The frameset properties for this document are specified by the following WordprocessingML within the web page settings:

<w:frameset>
  <w:frameLayout w:val="rows" />
  <w:frame>
    …
  </w:frame>
  <w:frameset>
    <w:frameLayout w:val="cols" />
    <w:frame>
      …
    </w:frame>
    <w:frame>
      …
    </w:frame>
  </w:frameset>
</w:frameset>

The parent frameset element specifies that the current document is a frameset definition; that frameset consists of a single frame and another nested frameset stacked vertically. end example]

Parent Elements
webSettings (§17.15.2.46)

Child Elements	Subclause
frame (Single Frame Properties)	§17.15.2.16
frameLayout (Frameset Layout)	§17.15.2.17
frameset (Nested Frameset Definition)	§17.15.2.18
framesetSplitbar (Frameset Splitter Properties)	§17.15.2.20
sz (Nested Frameset Size)	§17.15.2.41
title (Frame or Frameset Title)	§17.15.2.43

[Note: The W3C XML Schema definition of this element’s content model (CT_Frameset) 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.

See Also

Reference

Frameset Members

DocumentFormat.OpenXml.Wordprocessing Namespace