XmlStreamStore.GetAnnotations メソッド

定義

名前空間:

System.Windows.Annotations.Storage

アセンブリ:

PresentationFramework.dll

ストア内のすべての注釈の一覧を返します。

オーバーロード

GetAnnotations()	ストア内のすべての注釈の一覧を返します。
GetAnnotations(ContentLocator)	一致する ContentLocatorPart シーケンスで開始するロケーターを含む Anchors を持つ注釈の一覧を返します。

例

次の例は、 メソッドを GetAnnotations 使用して、ストアに含まれる注釈があるかどうかを判断する方法を示しています。

// ---------------------------- CloseFile -----------------------------
private void CloseFile()
{
    // If there are existing annotations, then they should be saved.
    if (_annStore.GetAnnotations().Count > 0)
    {
        string backupFile = _fileName + ".annotations" + ".xml";
        FileStream backupStream = new FileStream(backupFile, FileMode.Create);
        CopyStream(_annotationBuffer, backupStream);
        _annStore.Flush();
        _annServ.Disable();
    }
}

GetAnnotations()

ストア内のすべての注釈の一覧を返します。

public:
 override System::Collections::Generic::IList<System::Windows::Annotations::Annotation ^> ^ GetAnnotations();

public override System.Collections.Generic.IList<System.Windows.Annotations.Annotation> GetAnnotations ();

override this.GetAnnotations : unit -> System.Collections.Generic.IList<System.Windows.Annotations.Annotation>

Public Overrides Function GetAnnotations () As IList(Of Annotation)

戻り値

IList<Annotation>

ストア内に現在格納されているすべての注釈の一覧。

例外

ObjectDisposedException

Dispose はストアに呼び出されました。

例

次の例では、 メソッドを GetAnnotations 使用して、ストアに注釈があるかどうかを判断する方法を示します。

// ---------------------------- CloseFile -----------------------------
private void CloseFile()
{
    // If there are existing annotations, then they should be saved.
    if (_annStore.GetAnnotations().Count > 0)
    {
        string backupFile = _fileName + ".annotations" + ".xml";
        FileStream backupStream = new FileStream(backupFile, FileMode.Create);
        CopyStream(_annotationBuffer, backupStream);
        _annStore.Flush();
        _annServ.Disable();
    }
}

注釈

メソッドは GetAnnotations 返されません null。ただし、ストアに注釈が含まれない場合は、リストが空になる可能性があります。

こちらもご覧ください

• GetAnnotation(Guid)
• GetAnnotations(ContentLocator)

GetAnnotations(ContentLocator)

一致する ContentLocatorPart シーケンスで開始するロケーターを含む Anchors を持つ注釈の一覧を返します。

public:
 override System::Collections::Generic::IList<System::Windows::Annotations::Annotation ^> ^ GetAnnotations(System::Windows::Annotations::ContentLocator ^ anchorLocator);

public override System.Collections.Generic.IList<System.Windows.Annotations.Annotation> GetAnnotations (System.Windows.Annotations.ContentLocator anchorLocator);

override this.GetAnnotations : System.Windows.Annotations.ContentLocator -> System.Collections.Generic.IList<System.Windows.Annotations.Annotation>

Public Overrides Function GetAnnotations (anchorLocator As ContentLocator) As IList(Of Annotation)

パラメーター

anchorLocator

ContentLocator

一致する注釈を返す、先頭の ContentLocatorPart のシーケンス。

戻り値

IList<Annotation>

指定した Anchors で始まり、かつ一致するロケーターを含む anchorLocator を持つ注釈の一覧。一致する注釈が見つからなかった場合は null。

例

次の例では、 メソッドを GetAnnotations 使用して、ストアに注釈があるかどうかを判断する方法を示します。

// ---------------------------- CloseFile -----------------------------
private void CloseFile()
{
    // If there are existing annotations, then they should be saved.
    if (_annStore.GetAnnotations().Count > 0)
    {
        string backupFile = _fileName + ".annotations" + ".xml";
        FileStream backupStream = new FileStream(backupFile, FileMode.Create);
        CopyStream(_annotationBuffer, backupStream);
        _annStore.Flush();
        _annServ.Disable();
    }
}

注釈

このメソッドはGetAnnotations、 クラスの メソッドをStartsWithContentLocator内部的に使用して、返される注釈を検索して照合します。

こちらもご覧ください

• GetAnnotation(Guid)
• StartsWith(ContentLocator)