Setter Class (System.Windows)

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2010/.NET Framework 4

Other versions are also available for the following:

.NET Framework Class Library

Setter Class

Represents a setter that applies a property value.

Inheritance Hierarchy

System..::.Object
System.Windows..::.SetterBase
System.Windows..::.Setter

Namespace: System.Windows
Assembly: PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

Syntax

Visual Basic

<XamlSetMarkupExtensionAttribute("ReceiveMarkupExtension")> _
<XamlSetTypeConverterAttribute("ReceiveTypeConverter")> _
Public Class Setter _
    Inherits SetterBase _
    Implements ISupportInitialize

[XamlSetMarkupExtensionAttribute("ReceiveMarkupExtension")]
[XamlSetTypeConverterAttribute("ReceiveTypeConverter")]
public class Setter : SetterBase, ISupportInitialize

Visual C++

[XamlSetMarkupExtensionAttribute(L"ReceiveMarkupExtension")]
[XamlSetTypeConverterAttribute(L"ReceiveTypeConverter")]
public ref class Setter : public SetterBase, 
    ISupportInitialize

[<XamlSetMarkupExtensionAttribute("ReceiveMarkupExtension")>]
[<XamlSetTypeConverterAttribute("ReceiveTypeConverter")>]
type Setter =  
    class
        inherit SetterBase
        interface ISupportInitialize
    end

XAML Object Element Usage

<Setter .../>

The Setter type exposes the following members.

Constructors

	Name	Description
	Setter()()()	Initializes a new instance of the Setter class.
	Setter(DependencyProperty, Object)	Initializes a new instance of the Setter class with the specified property and value.
	Setter(DependencyProperty, Object, String)	Initializes a new instance of the Setter class with the specified property, value, and target name.

Top

Properties

	Name	Description
	IsSealed	Gets a value that indicates whether this object is in an immutable state. (Inherited from SetterBase.)
	Property	Gets or sets the property to which the Value will be applied.
	TargetName	Gets or sets the name of the object this Setter is intended for.
	Value	Gets or sets the value to apply to the property that is specified by this Setter.

Top

Methods

	Name	Description
	CheckSealed	Checks whether this object is read-only and cannot be changed. (Inherited from SetterBase.)
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ReceiveMarkupExtension	Handles cases where a markup extension provides a value for a property of Setter object.
	ReceiveTypeConverter	Handles cases where a type converter provides a value for a property of a Setter object.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	ISupportInitialize..::.BeginInit	Infrastructure. Signals the object that initialization is starting.
	ISupportInitialize..::.EndInit	Infrastructure. Signals the object that initialization is complete.

Top

Exceptions

Exception	Condition
ArgumentNullException	The Property property cannot be null.
ArgumentException	If the specified Property is a read-only property.
ArgumentException	If the specified Value is set to UnsetValue.

Remarks

Styles and the different types of triggers (classes that inherit from TriggerBase) use Setters to apply property values.

Note that you must specify both the Property and Value properties on a Setter for the setter to be meaningful. If one or both properties are not set, an exception will be thrown.

Examples

The following example defines a Style that will be applied to every TextBlock element. This Style applies values to several TextBlock properties with the use of Setters.

XAML

<Style TargetType="{x:Type TextBlock}">
  <Setter Property="FontFamily" Value="Segoe Black" />
  <Setter Property="HorizontalAlignment" Value="Center" />
  <Setter Property="FontSize" Value="12pt" />
  <Setter Property="Foreground" Value="#777777" />
</Style>

The following example shows a named Style available to Button controls. The Style defines a Trigger element that changes the Foreground property of a button when the IsPressed property is true.

XAML

<Style x:Key="Triggers" TargetType="Button">
    <Style.Triggers>
    <Trigger Property="IsPressed" Value="true">
        <Setter Property = "Foreground" Value="Green"/>
    </Trigger>
    </Style.Triggers>
</Style>

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Reference

System.Windows Namespace

EventSetter

TriggerBase

Other Resources

Styling and Templating

Data Templating Overview