LinkedToFile Class

Maintain Link to Existing File.When the object is serialized out as xml, its qualified name is w:linkedToFile.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.OnOffOnlyType
        DocumentFormat.OpenXml.Wordprocessing.LinkedToFile

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

Syntax

'Declaration
Public Class LinkedToFile _
    Inherits OnOffOnlyType
'Usage
Dim instance As LinkedToFile

public class LinkedToFile : OnOffOnlyType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.15.2.22 linkedToFile (Maintain Link to Existing File)

This element specifies that the file referenced by the sourceFileName element (§17.15.2.39) as the basis for the current frame shall not be changed, even when the file defined by the parent frameset is moved - i.e. the link shall remain exactly as specified.

[Guidance: Typically, when a document is incorporated into a frameset, a copy of that document is made such that all files encompassing the frameset are stored in a single subdirectory (so they can be moved as a single unit). However, if the link to the current file is absolute and must not be changed even when the location of the main frameset document, then this element must be set to indicate that setting. end guidance]

If this element is omitted, then a new file can be created as necessary when the parent frameset document is resaved to another location.

[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:frame>
    <w:sz w:val="20%" />
<w:name w:val="Frame 1" />
<w:sourceFileName r:id="rId1" />
<w:linkedToFile w:val="true" />
  </w:frame>
  <w:frameset>
    …
  </w:frameset>
</w:frameset>

The linkedToFile element specifies that the frame source location specified by the sourceFileName element (§17.15.2.39) must not be modified, even if the parent frameset document is resaved to another location. end example]

Parent Elements
frame (§17.15.2.16)

This element’s content model is defined by the common boolean property definition in §17.17.4.

© 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

LinkedToFile Members

DocumentFormat.OpenXml.Wordprocessing Namespace