ItemPolicy.GetSurrogateItems メソッド

2008-08-22

更新 : 2007 年 11 月

このアイテムに対するオプションのサロゲートアイテムのセットを返します。

名前空間 : Microsoft.Windows.Design.Policies
アセンブリ : Microsoft.Windows.Design.Extensibility (Microsoft.Windows.Design.Extensibility.dll 内)

構文

'宣言
Public Overridable Function GetSurrogateItems ( _
    item As ModelItem _
) As IEnumerable(Of ModelItem)
'使用
Dim instance As ItemPolicy
Dim item As ModelItem
Dim returnValue As IEnumerable(Of ModelItem)

returnValue = instance.GetSurrogateItems(item)

public virtual IEnumerable<ModelItem> GetSurrogateItems(
    ModelItem item
)

public:
virtual IEnumerable<ModelItem^>^ GetSurrogateItems(
    ModelItem^ item
)

public function GetSurrogateItems(
    item : ModelItem
) : IEnumerable<ModelItem>

パラメータ

item
型 : Microsoft.Windows.Design.Model.ModelItem

サロゲートを取得する対象のアイテム。

戻り値

型 : System.Collections.Generic.IEnumerable<ModelItem>

チェックするサロゲートアイテムの列挙体。既定では、空の列挙体が返されます。

解説

サロゲートアイテムは、指定されたアイテムに対する追加機能を提供します。サロゲートアイテムは、ポリシーのコンシューマに公開されるアイテムには含まれません。親オブジェクトから子に機能を提供する場合は、サロゲートアイテムを返す必要があります。サロゲートアイテムのセットを返すには、true を返すように IsSurrogate プロパティをオーバーライドします。

メモ :
独自の GetSurrogateItems の実装からは、nullnull 参照 (Visual Basic では Nothing) を返さないようにしてください。

例

IsSurrogate プロパティと GetSurrogateItems メソッドを実装して、カスタムサロゲートポリシーを作成する方法を次のコード例に示します。完全なコードの一覧については、「方法 : サロゲートポリシーを作成する」を参照してください。

' The DockPanelPolicy class implements a surrogate policy that
' provides container semantics for a selected item. By using 
' this policy, the DemoDockPanel container control offers 
' additional tasks and adorners on its children. 
Class DockPanelPolicy
    Inherits PrimarySelectionPolicy

    Public Overrides ReadOnly Property IsSurrogate() As Boolean 
        Get
            Return True
        End Get
    End Property

    Public Overrides Function GetSurrogateItems( _
        ByVal item As Microsoft.Windows.Design.Model.ModelItem) _
        As System.Collections.Generic.IEnumerable( _
        Of Microsoft.Windows.Design.Model.ModelItem)

        Dim parent As ModelItem = item.Parent

        Dim e As New System.Collections.Generic.List(Of ModelItem)

        If (parent IsNot Nothing) Then

            e.Add(parent)

        End If

        Return e

    End Function

End Class

// The DockPanelPolicy class implements a surrogate policy that
// provides container semantics for a selected item. By using 
// this policy, the DemoDockPanel container control offers 
// additional tasks and adorners on its children. 
class DockPanelPolicy : PrimarySelectionPolicy 
{
    public override bool IsSurrogate 
    {
        get 
        { 
            return true;
        }
    }

    public override IEnumerable<ModelItem> GetSurrogateItems(ModelItem item) 
    {
        ModelItem parent = item.Parent;

        if (parent != null)
        {
            yield return parent;
        }
    }
}