SaveThroughXslt Class

Article
08/03/2013

Custom XSL Transform To Use When Saving As XML File.When the object is serialized out as xml, its qualified name is w:saveThroughXslt.

Inheritance Hierarchy

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

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

Syntax

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

public class SaveThroughXslt : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

17.15.1.76 saveThroughXslt (Custom XSL Transform To Use When Saving As XML File)

This element specifies the location of a custom XSL transform which shall be used when this document is saved as a single XML file (in a format not defined by ISO/IEC 29500). [Guidance: Because this setting specifies behavior when saving to an alternative file format not defined by ISO/IEC 29500, this behavior is optional. end guidance]

If this element is omitted, then no custom XSL transform shall be used when saving this file as a single XML file. If the useXSLTWhenSaving element (§17.15.1.91) is omitted or set to false, then this transform shall not be applied when the document is saved as a single XML file.

[Example: Consider a XML document that must have the XSL transform applied when the document is saved as a single XML file. This requirement would be specified using the following WordprocessingML in the document settings:

<w:useXSLTWhenSaving w:val="on"/> 
<w:saveThroughXslt r:id="rId5" />

The useXSLTWhenSaving element's val is set to true indicating that applications must apply the XSLT specified by the relationship targeted by the id attribute of the saveThroughXslt element, located at rId5, when saving as a single XML file*. end example*]

Parent Elements
settings (§17.15.1.78)

Attributes	Description
id (XSL Transformation Location) Namespace: .../officeDocument/2006/relationships	Specifies an explicit relationship to the location of the XSL Transformation which shall be applied. The relationship targeted by this element shall be of type https://schemas.openxmlformats.org/officeDocument/2006/relationships/transform, or this document shall be declared non-conformant. [Example: Consider a XML document that must have the XSL transform located at c:\Example Transform.xslt applied when the document is saved as a single XML file. This requirement would be specified using the following WordprocessingML in the document settings: <w:saveThroughXslt r:id="rId5" /> The saveThroughXslt element specifies that the relationship located at rId5 must be used when saving as a single XML file in this case, that relationship must target c:\Example Transform.xslt. end example] The possible values for this attribute are defined by the ST_RelationshipId simple type (§22.8.2.1).
solutionID (Local Identifier for XSL Transform)	Specifies a string identifier which can be used to locate the XSL transform to be applied. The semantics of this attribute are not defined by ISO/IEC 29500 - applications can use this information in any application-defined manner to resolve the location of the XSL transform to apply. If this attribute is omitted, then no local identifier is specified for the XSL transform. If both this and the xslt attributes are present, then this data shall be used first, and the latter shall only be used if this information cannot be used successfully. [Example: Consider a XML document that must have the XSL transform identified by mySolution applied to when the document is saved as a single XML file. This requirement would be specified using the following WordprocessingML in the document settings: <w:saveThroughXslt w:solutionID="mySolution" /> The solutionID attribute has a value of mySolution indicating that applications must apply the XSLT identified by this value (if known) when saving as a single XML file. end example] The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).

id (XSL Transformation Location)

Namespace: .../officeDocument/2006/relationships

Specifies an explicit relationship to the location of the XSL Transformation which shall be applied.

The relationship targeted by this element shall be of type https://schemas.openxmlformats.org/officeDocument/2006/relationships/transform, or this document shall be declared non-conformant.

[Example: Consider a XML document that must have the XSL transform located at c:\Example Transform.xslt applied when the document is saved as a single XML file. This requirement would be specified using the following WordprocessingML in the document settings:

<w:saveThroughXslt r:id="rId5" />

The saveThroughXslt element specifies that the relationship located at rId5 must be used when saving as a single XML file in this case, that relationship must target c:\Example Transform.xslt. end example]

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

solutionID (Local Identifier for XSL Transform)

Specifies a string identifier which can be used to locate the XSL transform to be applied. The semantics of this attribute are not defined by ISO/IEC 29500 - applications can use this information in any application-defined manner to resolve the location of the XSL transform to apply.

If this attribute is omitted, then no local identifier is specified for the XSL transform. If both this and the xslt attributes are present, then this data shall be used first, and the latter shall only be used if this information cannot be used successfully.

[Example: Consider a XML document that must have the XSL transform identified by mySolution applied to when the document is saved as a single XML file. This requirement would be specified using the following WordprocessingML in the document settings:

<w:saveThroughXslt w:solutionID="mySolution" />

The solutionID attribute has a value of mySolution indicating that applications must apply the XSLT identified by this value (if known) when saving as a single XML file. end example]

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

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

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.

SaveThroughXslt Class

Inheritance Hierarchy

Syntax

Remarks

Thread Safety

See Also

Reference

Additional resources