Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
40 changes: 20 additions & 20 deletions xml/System.Windows.Annotations.Storage/AnnotationStore.xml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Windows.Annotations.Storage.StoreContentChangedEventArgs> data includes the <xref:System.Windows.Annotations.Storage.StoreContentChangedEventArgs.Annotation%2A> associated with the event and the <xref:System.Windows.Annotations.Storage.StoreContentAction> of <xref:System.Windows.Annotations.Storage.StoreContentAction.Added> or <xref:System.Windows.Annotations.Storage.StoreContentAction.Deleted>.
The <xref:System.Windows.Annotations.Storage.StoreContentChangedEventArgs> data includes the <xref:System.Windows.Annotations.Storage.StoreContentChangedEventArgs.Annotation*> associated with the event and the <xref:System.Windows.Annotations.Storage.StoreContentAction> of <xref:System.Windows.Annotations.Storage.StoreContentAction.Added> or <xref:System.Windows.Annotations.Storage.StoreContentAction.Deleted>.

]]></format>
</remarks>
Expand Down Expand Up @@ -146,7 +146,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
The operation performed with the <xref:System.Windows.Annotations.Storage.StoreContentChangedEventArgs.Annotation%2A> is specified by the <xref:System.Windows.Annotations.Storage.StoreContentChangedEventArgs.Action> property.
The operation performed with the <xref:System.Windows.Annotations.Storage.StoreContentChangedEventArgs.Annotation*> is specified by the <xref:System.Windows.Annotations.Storage.StoreContentChangedEventArgs.Action> property.

]]></format>
</remarks>
Expand Down
24 changes: 12 additions & 12 deletions xml/System.Windows.Annotations.Storage/XmlStreamStore.xml
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
This <xref:System.Windows.Annotations.Storage.XmlStreamStore.%23ctor%2A> constructor enables the registration of application-specific known namespaces.
This <xref:System.Windows.Annotations.Storage.XmlStreamStore.%23ctor*> constructor enables the registration of application-specific known namespaces.

The `knownNamespace` dictionary defines application namespaces that are used when you store custom content as part of an annotation. The dictionary key is the primary namespace known to the application program. The namespace key is associated with a value list of older namespaces that are compatible with the "key" namespace. When annotations are loaded all namespaces from this list will be replaced by the "key" namespace.

Expand Down Expand Up @@ -157,7 +157,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
When <xref:System.Windows.Annotations.Storage.XmlStreamStore.AddAnnotation%2A> is called, the <xref:System.Windows.Annotations.Annotation.Id%2A> of the <xref:System.Windows.Annotations.Annotation> is checked to see whether the <xref:System.Windows.Annotations.Annotation> already has been added to the store. If the <xref:System.Windows.Annotations.Annotation> already has been added and is in the store an <xref:System.ArgumentException> error is thrown.
When <xref:System.Windows.Annotations.Storage.XmlStreamStore.AddAnnotation*> is called, the <xref:System.Windows.Annotations.Annotation.Id*> of the <xref:System.Windows.Annotations.Annotation> is checked to see whether the <xref:System.Windows.Annotations.Annotation> already has been added to the store. If the <xref:System.Windows.Annotations.Annotation> already has been added and is in the store an <xref:System.ArgumentException> error is thrown.

]]></format>
</remarks>
Expand Down Expand Up @@ -235,7 +235,7 @@
<format type="text/markdown"><![CDATA[

## Examples
The following example shows use of the <xref:System.Windows.Annotations.Storage.XmlStreamStore.DeleteAnnotation%2A> and <xref:System.Windows.Annotations.Storage.XmlStreamStore.Flush%2A> methods.
The following example shows use of the <xref:System.Windows.Annotations.Storage.XmlStreamStore.DeleteAnnotation*> and <xref:System.Windows.Annotations.Storage.XmlStreamStore.Flush*> methods.

:::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserdelete":::

Expand Down Expand Up @@ -311,12 +311,12 @@
<format type="text/markdown"><![CDATA[

## Examples
The following example shows how to use the <xref:System.Windows.Annotations.Storage.XmlStreamStore.Flush%2A> method when the application closes the <xref:System.Windows.Annotations.AnnotationService>.
The following example shows how to use the <xref:System.Windows.Annotations.Storage.XmlStreamStore.Flush*> method when the application closes the <xref:System.Windows.Annotations.AnnotationService>.

:::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations/AnnotationDocumentPaginator/Overview/AnnotationsHelperXps.cs" id="Snippetstopannotations":::
:::code language="vb" source="~/snippets/visualbasic/System.Windows.Annotations/AnnotationDocumentPaginator/Overview/annotationshelperxps.vb" id="Snippetstopannotations":::

The following example shows use of the <xref:System.Windows.Annotations.Storage.XmlStreamStore.DeleteAnnotation%2A> and <xref:System.Windows.Annotations.Storage.XmlStreamStore.Flush%2A> methods.
The following example shows use of the <xref:System.Windows.Annotations.Storage.XmlStreamStore.DeleteAnnotation*> and <xref:System.Windows.Annotations.Storage.XmlStreamStore.Flush*> methods.

:::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserdelete":::

Expand Down Expand Up @@ -377,7 +377,7 @@
<format type="text/markdown"><![CDATA[

## Examples
The following example shows how to use the <xref:System.Windows.Annotations.Storage.XmlStreamStore.GetAnnotations%2A> method to determine whether there are any annotations contained in the store.
The following example shows how to use the <xref:System.Windows.Annotations.Storage.XmlStreamStore.GetAnnotations*> method to determine whether there are any annotations contained in the store.

:::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserclosefile":::

Expand Down Expand Up @@ -417,12 +417,12 @@
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Windows.Annotations.Storage.XmlStreamStore.GetAnnotations%2A> method will never return `null`; however the list may be empty if the store contains no annotations.
The <xref:System.Windows.Annotations.Storage.XmlStreamStore.GetAnnotations*> method will never return `null`; however the list may be empty if the store contains no annotations.



## Examples
The following example shows how to use the <xref:System.Windows.Annotations.Storage.XmlStreamStore.GetAnnotations%2A> method to determine whether there are any annotations in the store.
The following example shows how to use the <xref:System.Windows.Annotations.Storage.XmlStreamStore.GetAnnotations*> method to determine whether there are any annotations in the store.

:::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserclosefile":::

Expand Down Expand Up @@ -468,12 +468,12 @@
<format type="text/markdown"><![CDATA[

## Remarks
This <xref:System.Windows.Annotations.Storage.XmlStreamStore.GetAnnotations%2A> method internally uses the <xref:System.Windows.Annotations.ContentLocator.StartsWith%2A> method of the <xref:System.Windows.Annotations.ContentLocator> class to search and match for the annotations to return.
This <xref:System.Windows.Annotations.Storage.XmlStreamStore.GetAnnotations*> method internally uses the <xref:System.Windows.Annotations.ContentLocator.StartsWith*> method of the <xref:System.Windows.Annotations.ContentLocator> class to search and match for the annotations to return.



## Examples
The following example shows how to use the <xref:System.Windows.Annotations.Storage.XmlStreamStore.GetAnnotations%2A> method to determine whether there are any annotations in the store.
The following example shows how to use the <xref:System.Windows.Annotations.Storage.XmlStreamStore.GetAnnotations*> method to determine whether there are any annotations in the store.

:::code language="csharp" source="~/snippets/csharp/System.Windows.Annotations.Storage/AnnotationStore/DeleteAnnotation/ThumbViewer.cs" id="Snippetdocserclosefile":::

Expand Down Expand Up @@ -517,7 +517,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
The `name` parameter works only for predefined Microsoft Annotations Framework namespaces. For any other namespace given in the `name` parameter <xref:System.Windows.Annotations.Storage.XmlStreamStore.GetWellKnownCompatibleNamespaces%2A> will return `null`, even those namespaces registered through the `knownNamespaces` parameter of the <xref:System.Windows.Annotations.Storage.XmlStreamStore.%23ctor%2A> constructor.
The `name` parameter works only for predefined Microsoft Annotations Framework namespaces. For any other namespace given in the `name` parameter <xref:System.Windows.Annotations.Storage.XmlStreamStore.GetWellKnownCompatibleNamespaces*> will return `null`, even those namespaces registered through the `knownNamespaces` parameter of the <xref:System.Windows.Annotations.Storage.XmlStreamStore.%23ctor*> constructor.

The namespaces predefined by the Annotations Framework include the following:

Expand Down Expand Up @@ -572,7 +572,7 @@
## Remarks
The <xref:System.Windows.Annotations.Storage.XmlStreamStore.IgnoredNamespaces> property will never return `null`, however the returned list can be empty if no namespaces are ignored.

<xref:System.Windows.Annotations.Storage.XmlStreamStore.IgnoredNamespaces%2A> helps in XML markup compatibility when the program reads annotation content created by different versions of the Microsoft Annotations Framework. When an older application is given annotation content created using a newer version of the Annotations Framework, <xref:System.Windows.Annotations.Storage.XmlStreamStore.IgnoredNamespaces%2A> returns a list of the XML namespaces for elements and attributes not known to the older framework. Unknown XML elements and attributes associated with newer namespaces are ignored when the annotation content is read and deserialized by the older application. For more information, see the [XML Markup Compatibility Specification](/office/open-xml/general/introduction-to-markup-compatibility#markup-compatibility-in-the-open-xml-file-formats-specification).
<xref:System.Windows.Annotations.Storage.XmlStreamStore.IgnoredNamespaces*> helps in XML markup compatibility when the program reads annotation content created by different versions of the Microsoft Annotations Framework. When an older application is given annotation content created using a newer version of the Annotations Framework, <xref:System.Windows.Annotations.Storage.XmlStreamStore.IgnoredNamespaces*> returns a list of the XML namespaces for elements and attributes not known to the older framework. Unknown XML elements and attributes associated with newer namespaces are ignored when the annotation content is read and deserialized by the older application. For more information, see the [XML Markup Compatibility Specification](/office/open-xml/general/introduction-to-markup-compatibility#markup-compatibility-in-the-open-xml-file-formats-specification).

]]></format>
</remarks>
Expand Down
32 changes: 16 additions & 16 deletions xml/System.Windows.Annotations/Annotation.xml
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,17 @@
## Remarks
<xref:System.Windows.Annotations.Annotation> represents a single annotation with all associated anchoring and content data. An annotation consists of the following main elements.

- Zero, one, or more <xref:System.Windows.Annotations.Annotation.Anchors%2A> that identify what is being annotated.
- Zero, one, or more <xref:System.Windows.Annotations.Annotation.Anchors*> that identify what is being annotated.

- Zero, one, or more <xref:System.Windows.Annotations.Annotation.Cargos%2A> that contain the user data for the annotation.
- Zero, one, or more <xref:System.Windows.Annotations.Annotation.Cargos*> that contain the user data for the annotation.

- Zero, one, or more <xref:System.Windows.Annotations.Annotation.Authors%2A> that define who created the annotation.
- Zero, one, or more <xref:System.Windows.Annotations.Annotation.Authors*> that define who created the annotation.

- A <xref:System.Windows.Annotations.Annotation.CreationTime%2A> that specifies the date and time when the annotation was created.
- A <xref:System.Windows.Annotations.Annotation.CreationTime*> that specifies the date and time when the annotation was created.

- A <xref:System.Windows.Annotations.Annotation.LastModificationTime%2A> that specifies when the annotation was last updated.
- A <xref:System.Windows.Annotations.Annotation.LastModificationTime*> that specifies when the annotation was last updated.

- A unique annotation <xref:System.Windows.Annotations.Annotation.Id%2A> (a globally unique identifier (GUID)).
- A unique annotation <xref:System.Windows.Annotations.Annotation.Id*> (a globally unique identifier (GUID)).

]]></format>
</remarks>
Expand Down Expand Up @@ -244,9 +244,9 @@
<format type="text/markdown"><![CDATA[

## Remarks
Each <xref:System.Windows.Annotations.AnnotationResource> in the <xref:System.Windows.Annotations.Annotation.Anchors%2A> collection identifies a data selection to which the annotation is bound (in other words, "the data selection that is being annotated"). While most annotations refer to a single data selection and contain just one anchor <xref:System.Windows.Annotations.AnnotationResource>, multiple anchors can occur if a single annotation refers to multiple data selections.
Each <xref:System.Windows.Annotations.AnnotationResource> in the <xref:System.Windows.Annotations.Annotation.Anchors*> collection identifies a data selection to which the annotation is bound (in other words, "the data selection that is being annotated"). While most annotations refer to a single data selection and contain just one anchor <xref:System.Windows.Annotations.AnnotationResource>, multiple anchors can occur if a single annotation refers to multiple data selections.

The returned <xref:System.Windows.Annotations.Annotation.Anchors%2A> collection is never null; however, the collection may contain zero elements.
The returned <xref:System.Windows.Annotations.Annotation.Anchors*> collection is never null; however, the collection may contain zero elements.

]]></format>
</remarks>
Expand Down Expand Up @@ -288,10 +288,10 @@
<format type="text/markdown"><![CDATA[

## Remarks
The returned annotation type is the <xref:System.Xml.XmlQualifiedName> name passed as a parameter to the <xref:System.Windows.Annotations.Annotation.%23ctor%2A> constructor.
The returned annotation type is the <xref:System.Xml.XmlQualifiedName> name passed as a parameter to the <xref:System.Windows.Annotations.Annotation.%23ctor*> constructor.

> [!NOTE]
> <xref:System.Windows.Annotations.Annotation.AnnotationType%2A> returns `null` if the annotation was incorrectly constructed by using a parameterless constructor without parameters. (The parameterless constructor without parameters does not fully initialize the instance and is used only internally in combination with XML serialization.) To create a new annotation, applications should use the <xref:System.Windows.Annotations.Annotation.%23ctor%2A> constructor that takes an <xref:System.Xml.XmlQualifiedName> as a parameter.
> <xref:System.Windows.Annotations.Annotation.AnnotationType*> returns `null` if the annotation was incorrectly constructed by using a parameterless constructor without parameters. (The parameterless constructor without parameters does not fully initialize the instance and is used only internally in combination with XML serialization.) To create a new annotation, applications should use the <xref:System.Windows.Annotations.Annotation.%23ctor*> constructor that takes an <xref:System.Xml.XmlQualifiedName> as a parameter.

]]></format>
</remarks>
Expand Down Expand Up @@ -362,7 +362,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
The returned <xref:System.Windows.Annotations.Annotation.Authors%2A> collection is never `null`; however, the collection can contain zero elements if no author is specified.
The returned <xref:System.Windows.Annotations.Annotation.Authors*> collection is never `null`; however, the collection can contain zero elements if no author is specified.

]]></format>
</remarks>
Expand Down Expand Up @@ -400,7 +400,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
In addition to when a cargo is added or removed, <xref:System.Windows.Annotations.Annotation.CargoChanged> occurs on any modification to a cargo subpart, such as a change to an <xref:System.Xml.XmlElement> in the <xref:System.Windows.Annotations.AnnotationResource.Contents%2A> collection of a cargo.
In addition to when a cargo is added or removed, <xref:System.Windows.Annotations.Annotation.CargoChanged> occurs on any modification to a cargo subpart, such as a change to an <xref:System.Xml.XmlElement> in the <xref:System.Windows.Annotations.AnnotationResource.Contents*> collection of a cargo.

]]></format>
</remarks>
Expand Down Expand Up @@ -442,9 +442,9 @@
<format type="text/markdown"><![CDATA[

## Remarks
Each <xref:System.Windows.Annotations.AnnotationResource> in the <xref:System.Windows.Annotations.Annotation.Cargos%2A> collection contains user-defined data for the annotation.
Each <xref:System.Windows.Annotations.AnnotationResource> in the <xref:System.Windows.Annotations.Annotation.Cargos*> collection contains user-defined data for the annotation.

The returned <xref:System.Windows.Annotations.Annotation.Cargos%2A> collection is never null; however, the collection may contain zero elements if there is no user data for the annotation.
The returned <xref:System.Windows.Annotations.Annotation.Cargos*> collection is never null; however, the collection may contain zero elements if there is no user data for the annotation.

]]></format>
</remarks>
Expand Down Expand Up @@ -488,7 +488,7 @@
## Remarks

> [!NOTE]
> <xref:System.Windows.Annotations.Annotation.CreationTime%2A> returns <xref:System.DateTime.MinValue?displayProperty=nameWithType> if the annotation was incorrectly created by using the default <xref:System.Windows.Annotations.Annotation> constructor without parameters. An <xref:System.Windows.Annotations.Annotation> constructor with parameters should be used to correctly instantiate a new annotation.
> <xref:System.Windows.Annotations.Annotation.CreationTime*> returns <xref:System.DateTime.MinValue?displayProperty=nameWithType> if the annotation was incorrectly created by using the default <xref:System.Windows.Annotations.Annotation> constructor without parameters. An <xref:System.Windows.Annotations.Annotation> constructor with parameters should be used to correctly instantiate a new annotation.

]]></format>
</remarks>
Expand Down Expand Up @@ -566,7 +566,7 @@
## Remarks

> [!NOTE]
> <xref:System.Windows.Annotations.Annotation.Id%2A> returns <xref:System.Guid.Empty> if the annotation was instantiated by using the default <xref:System.Windows.Annotations.Annotation> constructor without parameters. An <xref:System.Windows.Annotations.Annotation> constructor with parameters should be used to correctly instantiate a new annotation with a valid GUID.
> <xref:System.Windows.Annotations.Annotation.Id*> returns <xref:System.Guid.Empty> if the annotation was instantiated by using the default <xref:System.Windows.Annotations.Annotation> constructor without parameters. An <xref:System.Windows.Annotations.Annotation> constructor with parameters should be used to correctly instantiate a new annotation with a valid GUID.

]]></format>
</remarks>
Expand Down
Loading
Loading