SourceFileReference class

Office 2013 and later

Source File for Frame. When the object is serialized out as xml, its qualified name is w:sourceFileName.

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

public class SourceFileReference : RelationshipType

[ISO/IEC 29500-1 1st Edition]

sourceFileName (Source File for Frame)

This element specifies the ID for the relationship which specifies the source file for a single frame within a frameset document.

The relationship referenced by this element's id attribute shall exist in the relationship part item for the Web Settings part,or this document shall be considered non-conformant. Also, the type of the relationship referenced by this element's id attribute shall be http://schemas.openxmlformats.org/officeDocument/2006/relationships/frame, or this document shall be considered non-conformant.

If this element is omitted, then no source file is present for the current frame, and one can be created dynamically as needed to display content within the frame.

[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:frameset>
    …    <w:frame>
      <w:name w:val="Frame 2" />
      <w:sourceFileName r:id="rId5" />
    </w:frame>
    …
  </w:frameset>
</w:frameset>

The sourceFileName element specifies that the contents of this frame must be the contents of the file targeted by the relationship with ID rId5 in the web settings part's relationship part item. end example]

Parent Elements

frame (§17.15.2.16)

Attributes

Description

id (Relationship to Part)

Namespace: .../officeDocument/2006/relationships

Specifies the relationship ID to a specified part.

The specified relationship shall match the relationship type required by the parent element:

  • http://schemas.openxmlformats.org/officeDocument/2006/customXml for the contentPart element

  • http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer for the footerReference element

  • http://schemas.openxmlformats.org/officeDocument/2006/relationships/header for the headerReference element

  • http://schemas.openxmlformats.org/officeDocument/2006/relationships/font for the embedBold, embedBoldItalic, embedItalic, or embedRegular elements

  • http://schemas.openxmlformats.org/officeDocument/2006/relationships/printerSettings for the printerSettings element

  • http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink for the longDesc or hyperlink element

[Example: Consider an XML element which has the following id attribute:

<… r:id="rId10" />

The markup specifies the associated relationship part with relationship ID rId1 contains the corresponding relationship information for the parent XML element. end example]

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

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

© ISO/IEC29500: 2008.

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