Share via


Inserted Class

Inserted Paragraph.When the object is serialized out as xml, its qualified name is w:ins.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.TrackChangeType
        DocumentFormat.OpenXml.Wordprocessing.Inserted

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

Syntax

'Declaration
Public Class Inserted _
    Inherits TrackChangeType
'Usage
Dim instance As Inserted
public class Inserted : TrackChangeType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.13.2.17 ins (Inserted Table Row)

This element specifies that the parent table row shall be treated as an inserted row whose insertion has been tracked as a revision. This setting shall not imply any revision state about the table cells in this row or their contents (which shall be revision marked independently), and shall only affect the table row itself.

[Example: Consider a two row by two column table in which the second row has been marked as inserted using a revision. This requirement would be specified using the following WordprocessingML:

<w:tbl>
…
<w:tr>
<w:tc>
<w:p/>
</w:tc>
<w:tc>
<w:p/>
</w:tc>
</w:tr>
<w:tr>
<w:trPr>
<w:ins w:id="0" … />
</w:trPr>
<w:tc>
<w:p/>
</w:tc>
<w:tc>
<w:p/>
</w:tc>
</w:tr>
</w:tbl>

The ins element on the table row properties for the second table row specifies that this row was inserted, and this insertion was tracked as a revision. end example]

Parent Elements

trPr (§17.4.82); trPr (§17.7.6.10); trPr (§17.7.6.11)

Attributes

Description

author (Annotation Author)

Specifies the author for an annotation within a WordprocessingML document.

If this attribute is omitted, then no author shall be associated with the parent annotation type.

[Example: Consider a comment represented using the following WordprocessingML fragment:

<… w:id="1" w:author="Example Author">
  …
</…>

The author attribute specifies that the author of the current annotation is Example Author, which can be used as desired. end example]

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

date (Annotation Date)

Specifies the date information for an annotation within a WordprocessingML document. The use of this information is outside of the scope of ISO/IEC 29500.

If this attribute is omitted, then no date information shall be associated with the parent annotation type.

[Example: Consider a comment represented using the following WordprocessingML fragment:

<… w:id="1" w:date="2006-01-01T10:00:00">
  …
</…>

The date attribute specifies that the date of the current annotation is January 1st 2006 at 10:00 AM, which can be used as desired. end example]

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

id (Annotation Identifier)

Specifies a unique identifier for an annotation within a WordprocessingML document. The restrictions on the id attribute, if any, are defined by the parent XML element.

If this attribute is omitted, then the document is non-conformant.

[Example: Consider an annotation represented using the following WordprocessingML fragment:

<… w:id="1" … >
  …
</…>

The id attribute specifies that the ID of the current annotation is 1. This value is used to uniquely identify this annotation within the document content. end example]

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

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

[ISO/IEC 29500-1 1st Edition]

17.13.2.19 ins (Inserted Numbering Properties)

This element specifies that the numbering information defined by the parent element shall be treated as numbering information which was recorded as an insertion using revisions.

[Example: Consider two paragraphs in a WordprocessingML document, with the words one and two respectively, as follows:

DocumentFormat.OpenXml.Wordprocessing.Inserted-ima

If numbering is then applied to these two paragraphs, and this numbering is tracked as a revision, this revision is represented using the following WordprocessingML:

<w:p>
<w:pPr>
<w:numPr>
<w:ilvl w:val="0" />
<w:numId w:val="1" />
<w:ins w:id="0" w:author="Joe Smith" w:date="2005-01-01T10:00:00Z" />
</w:numPr>
</w:pPr>
<w:r>
<w:t>one</w:t>
</w:r>
</w:p>
<w:p>
<w:pPr>
<w:numPr>
<w:ilvl w:val="0" />
<w:numId w:val="1" />
<w:ins w:id="0" w:author="Joe Smith" w:date="2005-01-01T10:00:00Z" />
</w:numPr>
</w:pPr>
<w:r>
<w:t>two</w:t>
</w:r>
</w:p>

The ins element as a child of the numbering properties specifies that the paragraphs in this document have been given numbering properties by Joe Smith and that this change was marked as a revision. end example]

Parent Elements

numPr (§17.3.1.19)

Attributes

Description

author (Annotation Author)

Specifies the author for an annotation within a WordprocessingML document.

If this attribute is omitted, then no author shall be associated with the parent annotation type.

[Example: Consider a comment represented using the following WordprocessingML fragment:

<… w:id="1" w:author="Example Author">
  …
</…>

The author attribute specifies that the author of the current annotation is Example Author, which can be used as desired. end example]

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

date (Annotation Date)

Specifies the date information for an annotation within a WordprocessingML document. The use of this information is outside of the scope of ISO/IEC 29500.

If this attribute is omitted, then no date information shall be associated with the parent annotation type.

[Example: Consider a comment represented using the following WordprocessingML fragment:

<… w:id="1" w:date="2006-01-01T10:00:00">
  …
</…>

The date attribute specifies that the date of the current annotation is January 1st 2006 at 10:00 AM, which can be used as desired. end example]

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

id (Annotation Identifier)

Specifies a unique identifier for an annotation within a WordprocessingML document. The restrictions on the id attribute, if any, are defined by the parent XML element.

If this attribute is omitted, then the document is non-conformant.

[Example: Consider an annotation represented using the following WordprocessingML fragment:

<… w:id="1" … >
  …
</…>

The id attribute specifies that the ID of the current annotation is 1. This value is used to uniquely identify this annotation within the document content. end example]

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

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

[ISO/IEC 29500-1 1st Edition]

17.13.2.20 ins (Inserted Paragraph)

This element specifies that the paragraph mark delimiting the end of a paragraph within a WordprocessingML document shall be treated as deleted (i.e. the contents of this paragraph are no longer delimited by this paragraph mark, and are combined with the following paragraph) as part of a tracked revision.

[Example: Consider a document consisting of a single paragraph, as follows:

DocumentFormat.OpenXml.Wordprocessing.Inserted-ima

If the first sentence is moved into its own new paragraph, and this change is tracked as a revision, resulting in the following:

DocumentFormat.OpenXml.Wordprocessing.Inserted-ima

This revision is represented using the following WordprocessingML:

<w:p>
<w:pPr>
<w:rPr>
<w:ins w:id="0" … />
</w:rPr>
</w:pPr>
<w:r>
<w:t>This is paragraph one.</w:t>
</w:r>
</w:p>
<w:p>
<w:r>
<w:t>This is paragraph two.</w:t>
</w:r>
</w:p>

The ins element on the run properties for the first paragraph mark specifies that this paragraph mark was inserted, and this insertion was tracked as a revision. end example]

Parent Elements

rPr (§17.3.1.29); rPr (§17.3.1.30)

Attributes

Description

author (Annotation Author)

Specifies the author for an annotation within a WordprocessingML document.

If this attribute is omitted, then no author shall be associated with the parent annotation type.

[Example: Consider a comment represented using the following WordprocessingML fragment:

<… w:id="1" w:author="Example Author">
  …
</…>

The author attribute specifies that the author of the current annotation is Example Author, which can be used as desired. end example]

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

date (Annotation Date)

Specifies the date information for an annotation within a WordprocessingML document. The use of this information is outside of the scope of ISO/IEC 29500.

If this attribute is omitted, then no date information shall be associated with the parent annotation type.

[Example: Consider a comment represented using the following WordprocessingML fragment:

<… w:id="1" w:date="2006-01-01T10:00:00">
  …
</…>

The date attribute specifies that the date of the current annotation is January 1st 2006 at 10:00 AM, which can be used as desired. end example]

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

id (Annotation Identifier)

Specifies a unique identifier for an annotation within a WordprocessingML document. The restrictions on the id attribute, if any, are defined by the parent XML element.

If this attribute is omitted, then the document is non-conformant.

[Example: Consider an annotation represented using the following WordprocessingML fragment:

<… w:id="1" … >
  …
</…>

The id attribute specifies that the ID of the current annotation is 1. This value is used to uniquely identify this annotation within the document content. end example]

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

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

Inserted Members

DocumentFormat.OpenXml.Wordprocessing Namespace