CustomStrokes.Remove メソッド

2008-10-28

CustomStrokes コレクションから Strokes コレクションを削除します。

名前空間 : Microsoft.Ink
アセンブリ : Microsoft.Ink (Microsoft.Ink.dll 内)

構文

'宣言
Public Sub Remove ( _
    s As String _
)
'使用
Dim instance As CustomStrokes
Dim s As String

instance.Remove(s)

public void Remove(
    string s
)

public:
void Remove(
    String^ s
)

public void Remove(
    String s
)

public function Remove(
    s : String
)

パラメータ

s
型 : System.String
Strokes コレクションを CustomStrokes コレクションに追加するために使用された名前。

解説

このメソッドが呼び出されると、s パラメータを設定して追加されたのと同じ Strokes コレクションが削除されます。

CustomStrokes コレクションはインクデータへの参照のセットであり、実際のデータ自体ではありません。このメソッドは、データのスナップショットまたはデータへの参照からのみ Strokes コレクションを削除し、実際のインクデータからは Strokes コレクションを削除しません。実際のインクデータからコレクションを削除するには、Ink.DeleteStrokes メソッドを呼び出します。

name が CustomStrokes コレクションの既存のメンバと一致しない場合は System.ArgumentException が発生します。

例

この例では、CustomStrokes コレクション内に存在する、指定された名前を持つ Strokes コレクションが削除されます。指定された名前を持つ Strokes コレクションが存在しない場合は、例外が発生します。

Private Sub RemoveCustomStrokes(ByVal mName As String, ByVal mInk As Ink)
    Try
        ' if the name does not exist, an exception will be raised
        mInk.CustomStrokes.Remove(mName)
    Catch E As ArgumentException
        ' this exception is raised when the named collection does not exist
    End Try

End Sub

private void RemoveCustomStrokes(string mName, Ink mInk)
{
    try
    {
        // if the name does not exist, an exception will be raised
        mInk.CustomStrokes.Remove(mName);
    }
    catch (ArgumentException)
    {
        // this exception is raised when the named collection does not exist
    }

}