ControlTemplate クラス

定義

コントロールの複数のインスタンスで共有できる、Control のビジュアル構造と動作特性を指定します。Specifies the visual structure and behavioral aspects of a Control that can be shared across multiple instances of the control.

public ref class ControlTemplate : System::Windows::FrameworkTemplate
[System.Windows.Localizability(System.Windows.LocalizationCategory.None, Readability=System.Windows.Readability.Unreadable)]
[System.Windows.Markup.DictionaryKeyProperty("TargetType")]
public class ControlTemplate : System.Windows.FrameworkTemplate
type ControlTemplate = class
    inherit FrameworkTemplate
Public Class ControlTemplate
Inherits FrameworkTemplate
継承
属性

次に、ButtonControlTemplate を設定する Style Button を示します。The following shows a Button Style that sets the ControlTemplate of a Button:

<Style TargetType="Button">
  <!--Set to true to not get any properties from the themes.-->
  <Setter Property="OverridesDefaultStyle" Value="True"/>
  <Setter Property="Template">
    <Setter.Value>
      <ControlTemplate TargetType="Button">
        <Grid>
          <Ellipse Fill="{TemplateBinding Background}"/>
          <ContentPresenter HorizontalAlignment="Center"
                            VerticalAlignment="Center"/>
        </Grid>
      </ControlTemplate>
    </Setter.Value>
  </Setter>
</Style>

これを適用すると、ButtonEllipseとして表示されます。When this gets applied, the Button appears as an Ellipse:

Button ControlTemplate サンプルButton ControlTemplate sample

上の例のように、Control の [Template] プロパティを新しい ControlTemplate に設定すると、テンプレート全体が置換されます。When you set the Template property of a Control to a new ControlTemplate as in the above example, you are replacing the entire template. フォーカスがあるとき、または押されたときの Button は、置換するボタンの既定の外観の一部になります。What the Button looks like when it is in focus or pressed is all part of the default appearance of the button that you are replacing. したがって、次の例に示すように、必要に応じて、ボタンが押されたときにどのように表示されるかを定義に追加することができます。Therefore, depending on your needs, you may want to put in your definition what your button should look like when it is pressed, and so on, as in the following example:

<Style TargetType="Button">
  <Setter Property="SnapsToDevicePixels"
          Value="true" />
  <Setter Property="OverridesDefaultStyle"
          Value="true" />
  <Setter Property="FocusVisualStyle"
          Value="{StaticResource ButtonFocusVisual}" />
  <Setter Property="MinHeight"
          Value="23" />
  <Setter Property="MinWidth"
          Value="75" />
  <Setter Property="Template">
    <Setter.Value>
      <ControlTemplate TargetType="Button">
        <Border TextBlock.Foreground="{TemplateBinding Foreground}"
                x:Name="Border"
                CornerRadius="2"
                BorderThickness="1">
          <Border.BorderBrush>
            <LinearGradientBrush StartPoint="0,0"
                                 EndPoint="0,1">
              <LinearGradientBrush.GradientStops>
                <GradientStopCollection>
                  <GradientStop Color="{DynamicResource BorderLightColor}"
                                Offset="0.0" />
                  <GradientStop Color="{DynamicResource BorderDarkColor}"
                                Offset="1.0" />
                </GradientStopCollection>
              </LinearGradientBrush.GradientStops>
            </LinearGradientBrush>

          </Border.BorderBrush>
          <Border.Background>
            <LinearGradientBrush EndPoint="0.5,1"
                                 StartPoint="0.5,0">
              <GradientStop Color="{DynamicResource ControlLightColor}"
                            Offset="0" />
              <GradientStop Color="{DynamicResource ControlMediumColor}"
                            Offset="1" />
            </LinearGradientBrush>
          </Border.Background>
          <VisualStateManager.VisualStateGroups>
            <VisualStateGroup x:Name="CommonStates">
              <VisualStateGroup.Transitions>
                <VisualTransition GeneratedDuration="0:0:0.5" />
                <VisualTransition GeneratedDuration="0"
                                  To="Pressed" />
              </VisualStateGroup.Transitions>
              <VisualState x:Name="Normal" />
              <VisualState x:Name="MouseOver">
                <Storyboard>
                  <ColorAnimationUsingKeyFrames Storyboard.TargetProperty="(Panel.Background).
                      (GradientBrush.GradientStops)[1].(GradientStop.Color)"
                                                Storyboard.TargetName="Border">
                    <EasingColorKeyFrame KeyTime="0"
                                         Value="{StaticResource ControlMouseOverColor}" />
                  </ColorAnimationUsingKeyFrames>
                </Storyboard>
              </VisualState>
              <VisualState x:Name="Pressed">
                <Storyboard>
                  <ColorAnimationUsingKeyFrames Storyboard.TargetProperty="(Panel.Background).
                      (GradientBrush.GradientStops)[1].(GradientStop.Color)"
                                                Storyboard.TargetName="Border">
                    <EasingColorKeyFrame KeyTime="0"
                                         Value="{StaticResource ControlPressedColor}" />
                  </ColorAnimationUsingKeyFrames>
                  <ColorAnimationUsingKeyFrames Storyboard.TargetProperty="(Border.BorderBrush).
                      (GradientBrush.GradientStops)[0].(GradientStop.Color)"
                                                Storyboard.TargetName="Border">
                    <EasingColorKeyFrame KeyTime="0"
                                         Value="{StaticResource PressedBorderDarkColor}" />
                  </ColorAnimationUsingKeyFrames>
                  <ColorAnimationUsingKeyFrames Storyboard.TargetProperty="(Border.BorderBrush).
                      (GradientBrush.GradientStops)[1].(GradientStop.Color)"
                                                Storyboard.TargetName="Border">
                    <EasingColorKeyFrame KeyTime="0"
                                         Value="{StaticResource PressedBorderLightColor}" />
                  </ColorAnimationUsingKeyFrames>
                </Storyboard>
              </VisualState>
              <VisualState x:Name="Disabled">
                <Storyboard>
                  <ColorAnimationUsingKeyFrames Storyboard.TargetProperty="(Panel.Background).
                      (GradientBrush.GradientStops)[1].(GradientStop.Color)"
                                                Storyboard.TargetName="Border">
                    <EasingColorKeyFrame KeyTime="0"
                                         Value="{StaticResource DisabledControlDarkColor}" />
                  </ColorAnimationUsingKeyFrames>
                  <ColorAnimationUsingKeyFrames
                      Storyboard.TargetProperty="(TextBlock.Foreground).(SolidColorBrush.Color)"
                                                Storyboard.TargetName="Border">
                    <EasingColorKeyFrame KeyTime="0"
                                         Value="{StaticResource DisabledForegroundColor}" />
                  </ColorAnimationUsingKeyFrames>
                  <ColorAnimationUsingKeyFrames Storyboard.TargetProperty="(Border.BorderBrush).
                      (GradientBrush.GradientStops)[1].(GradientStop.Color)"
                                                Storyboard.TargetName="Border">
                    <EasingColorKeyFrame KeyTime="0"
                                         Value="{StaticResource DisabledBorderDarkColor}" />
                  </ColorAnimationUsingKeyFrames>
                </Storyboard>
              </VisualState>
            </VisualStateGroup>
          </VisualStateManager.VisualStateGroups>
          <ContentPresenter Margin="2"
                            HorizontalAlignment="Center"
                            VerticalAlignment="Center"
                            RecognizesAccessKey="True" />
        </Border>
        <ControlTemplate.Triggers>
          <Trigger Property="IsDefault"
                   Value="true">

            <Setter TargetName="Border"
                    Property="BorderBrush">
              <Setter.Value>
                <LinearGradientBrush StartPoint="0,0"
                                     EndPoint="0,1">
                  <GradientBrush.GradientStops>
                    <GradientStopCollection>
                      <GradientStop Color="{DynamicResource DefaultBorderBrushLightBrush}"
                                    Offset="0.0" />
                      <GradientStop Color="{DynamicResource DefaultBorderBrushDarkColor}"
                                    Offset="1.0" />
                    </GradientStopCollection>
                  </GradientBrush.GradientStops>
                </LinearGradientBrush>

              </Setter.Value>
            </Setter>
          </Trigger>
        </ControlTemplate.Triggers>
      </ControlTemplate>
    </Setter.Value>
  </Setter>
</Style>

この例では、ここに記載されていないリソースを参照しています。Note that this example references resources that are not shown here. 完全なサンプルについては、Styling with ControlTemplates Sampleを参照してください。For the complete sample, see Styling with ControlTemplates Sample. このサンプルでは、多くのコントロールのコントロールテンプレートの例を示し、コントロールテンプレートの作成を開始するための最適な方法です。That sample provides examples of control templates for many controls and is the best way for you to get started with creating control templates.

注釈

ControlTemplate を使用すると、コントロールの視覚的な構造を指定できます。The ControlTemplate allows you to specify the visual structure of a control. コントロールの作成者は既定の ControlTemplate を定義できます。また、アプリケーションの作成者は、ControlTemplate をオーバーライドして、コントロールの視覚的な構造を再構築できます。The control author can define the default ControlTemplate and the application author can override the ControlTemplate to reconstruct the visual structure of the control.

コントロールテンプレートは、WPFWPF スタイルとテンプレートモデルによって提供される多くの機能の1つです。Control templating is one of the many features offered by the WPFWPF styling and templating model. スタイルとテンプレートモデルを使用すると、多くの場合、独自のコントロールを作成する必要がないという優れた柔軟性が得られます。The styling and templating model provides you with such great flexibility that in many cases you do not need to write your own controls. コントロールの視覚化を変更するか、既存のコントロールの ControlTemplate を置き換えるアプリケーションの作成者は、スタイルとテンプレートに関するトピックの例と詳細な説明を参照してください。If you are an application author that wants to change the visualization of your control or to replace the ControlTemplate of an existing control, see the Styling and Templating topic for examples and an in-depth discussion.

独自のコントロールを作成する場合は、コントロール作成の概要に関するトピックの「カスタムコントロールを作成する」を参照してください。If you are writing your own control, see "Create a Custom Control" in the Control Authoring Overview.

ControlTemplate は、スタイルなど、外部のユーザーやオブジェクトには見えない、実装の詳細の自己完結型の単位として使用することを目的としています。A ControlTemplate is intended to be a self-contained unit of implementation detail that is invisible to outside users and objects, including styles. コントロールテンプレートの内容を操作する唯一の方法は、同じコントロールテンプレート内からです。The only way to manipulate the content of the control template is from within the same control template.

XAML プロパティ要素の使用XAML Property Element Usage

<ControlTemplate>  
  <VisualTreeRootNode>
    VisualTreeNodeContents  
  </VisualTreeRootNode>  
</ControlTemplate>  

XAML の値XAML Values

ControlTemplateControlTemplate
ControlTemplate または派生クラスのオブジェクト要素。Object element for ControlTemplate or a derived class.

VisualTreeRootNodeVisualTreeRootNode
ControlTemplate (または派生クラス) の直接の子としての単一の XAMLXAML 要素。A single XAMLXAML element as the immediate child of the ControlTemplate (or a derived class). テンプレートには単一のルートノードが必要です。Templates must have a single root node. 便利なテンプレートを生成するために、 VisualTreeRootNodeとして選択された要素は、独自のコンテンツモデルをサポートする必要があります。多くの場合、複数の子要素をサポートするモデルです。In order to generate a useful template, the element chosen as VisualTreeRootNode is expected to support a content model of its own, often a model that supports multiple child elements.

VisualTreeNodeContentsVisualTreeNodeContents
目的のテンプレートを完成させる1つ以上の要素。One or more elements that complete the intended template. VisualTreeRootNodeとして選択された要素が単一の子をサポートする場合、 VisualTreeNodeContentsとして宣言できる要素は1つだけです。If the element chosen as VisualTreeRootNode only supports a single child, then there can only be one element declared as VisualTreeNodeContents. また、選択したVisualTreeRootNodeでテキストコンテンツプロパティがサポートされている場合は、テキストコンテンツを提供することもできます (珍しいことはありません)。It is also possible (though uncommon) to provide text content if the chosen VisualTreeRootNode supports a text content property.

コンストラクター

ControlTemplate()

ControlTemplate クラスの新しいインスタンスを初期化します。Initializes a new instance of the ControlTemplate class.

ControlTemplate(Type)

指定された対象の型を使用して ControlTemplate クラスの新しいインスタンスを初期化します。Initializes a new instance of the ControlTemplate class with the specified target type.

プロパティ

Dispatcher

この Dispatcher が関連付けられている DispatcherObject を取得します。Gets the Dispatcher this DispatcherObject is associated with.

(継承元 DispatcherObject)
HasContent

最適化されたコンテンツがこのテンプレートに含まれているかどうかを示す値を取得します。Gets a value that indicates whether this template has optimized content.

(継承元 FrameworkTemplate)
IsSealed

このオブジェクトが不変の状態で変更不可能であるかどうかを示す値を取得します。Gets a value that indicates whether this object is in an immutable state so it cannot be changed.

(継承元 FrameworkTemplate)
Resources

このテンプレートのスコープ内で使用できるリソースのコレクションを取得または設定します。Gets or sets the collection of resources that can be used within the scope of this template.

(継承元 FrameworkTemplate)
TargetType

この ControlTemplate が対象としている型を取得または設定します。Gets or sets the type for which this ControlTemplate is intended.

Template

ライターがテンプレートを定義または適用するときに、テンプレートの XAML ノードを記録または再生するオブジェクトへの参照を取得または設定します。Gets or sets a reference to the object that records or plays the XAML nodes for the template when the template is defined or applied by a writer.

(継承元 FrameworkTemplate)
Triggers

プロパティの変更を適用する、または指定した条件に基づいてアクションを実行する TriggerBase オブジェクトのコレクションを取得します。Gets a collection of TriggerBase objects that apply property changes or perform actions based on specified conditions.

VisualTree

テンプレートのルート ノードを取得または設定します。Gets or sets the root node of the template.

(継承元 FrameworkTemplate)

メソッド

CheckAccess()

呼び出し元のスレッドがこの DispatcherObject にアクセスできるかどうかを確認します。Determines whether the calling thread has access to this DispatcherObject.

(継承元 DispatcherObject)
Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)
FindName(String, FrameworkElement)

このテンプレート内で定義された、指定した名前に関連付けられている要素を検索します。Finds the element associated with the specified name defined within this template.

(継承元 FrameworkTemplate)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
LoadContent()

テンプレートのコンテンツをオブジェクトのインスタンスとして読み込み、コンテンツのルート要素を返します。Loads the content of the template as an instance of an object and returns the root element of the content.

(継承元 FrameworkTemplate)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
RegisterName(String, Object)

現在の名前スコープに新しい名前とオブジェクトのペアを登録します。Registers a new name/object pair into the current name scope.

(継承元 FrameworkTemplate)
Seal()

テンプレートをロックし、変更できないようにします。Locks the template so it cannot be changed.

(継承元 FrameworkTemplate)
ShouldSerializeResources(XamlDesignerSerializationManager)

シリアル化プロセスが、このクラスのインスタンスの Resources プロパティの値をシリアル化する必要があるかどうかを示す値を返します。Returns a value that indicates whether serialization processes should serialize the value of the Resources property on instances of this class.

(継承元 FrameworkTemplate)
ShouldSerializeVisualTree()

シリアル化プロセスが、このクラスのインスタンスの VisualTree プロパティの値をシリアル化する必要があるかどうかを示す値を返します。Returns a value that indicates whether serialization processes should serialize the value of the VisualTree property on instances of this class.

(継承元 FrameworkTemplate)
ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)
UnregisterName(String)

XAML 名前スコープから名前とオブジェクトのマッピングを削除します。Removes a name/object mapping from the XAML namescope.

(継承元 FrameworkTemplate)
ValidateTemplatedParent(FrameworkElement)

規則のセットに対してテンプレートが適用される親をチェックします。Checks the templated parent against a set of rules.

VerifyAccess()

呼び出し元のスレッドがこの DispatcherObject にアクセスできるように強制します。Enforces that the calling thread has access to this DispatcherObject.

(継承元 DispatcherObject)

明示的なインターフェイスの実装

INameScope.FindName(String)

指定された識別名を持つオブジェクトを返します。Returns an object that has the provided identifying name.

(継承元 FrameworkTemplate)
IQueryAmbient.IsAmbientPropertyAvailable(String)

指定されたアンビエント プロパティを現在のスコープで使用できるかどうかを照会します。Queries whether a specified ambient property is available in the current scope.

(継承元 FrameworkTemplate)
ISealable.CanSeal (継承元 FrameworkTemplate)
ISealable.IsSealed (継承元 FrameworkTemplate)
ISealable.Seal() (継承元 FrameworkTemplate)

適用対象

こちらもご覧ください