FrameLayout Class

  • Article

Frameset Layout.When the object is serialized out as xml, its qualified name is w:frameLayout.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.FrameLayout

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

Syntax

'Declaration
Public Class FrameLayout _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As FrameLayout

public class FrameLayout : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

17.15.2.17 frameLayout (Frameset Layout)

This element specifies the order in which the frames (and nested framesets) in a frameset shall be displayed. When a frameset is created, it can only contain frames which are stacked in one direction:

  • Vertically (one on top of another)

  • Horizontally (one next to another)

This element specifies how the frames in this frameset are stacked, which shall also be used to interpret the sizes defined by the sz element (§17.15.2.40) for each frame. In order to determine the ordering of the constituent frames within this frameset, the ordering of the child frame and frameset elements shall be used.

If this element is omitted, then the frames in this frameset shall be stacked vertically on top of one another (a row frameset).

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

DocumentFormat.OpenXml.Wordprocessing.FrameLayout-

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 frameLayout element specifies that the outer frameset is a consists of the single frame and the child frameset stacked vertically, and an inner nested frameset consisting of two frames stacked horizontally. end example]

Parent Elements

frameset (§17.15.2.18); frameset (§17.15.2.19)

Attributes

Description

val (Frameset Layout Value)

Specifies the type of layout which shall be used to display the contents of the frames and nested framesets within this frameset, as defined by the simple type referenced below.

[Example: Consider a frameset definition within a WordprocessingML document which defines the following frameset layout setting:

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

The val attribute value of cols specifies that the contents of this frameset must be stacked horizontally (in columns). end example]

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

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

FrameLayout Members

DocumentFormat.OpenXml.Wordprocessing Namespace