FrameworkElement.Tag Property (System.Windows)

Tag Property

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

FrameworkElement..::.Tag Property

Gets or sets an arbitrary object value that can be used to store custom information about this element. This is a dependency property.

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

Syntax

Visual Basic (Declaration)

<LocalizabilityAttribute(LocalizationCategory.NeverLocalize)> _
Public Property Tag As Object

Visual Basic (Usage)

Dim instance As FrameworkElement
Dim value As Object

value = instance.Tag

instance.Tag = value

[LocalizabilityAttribute(LocalizationCategory.NeverLocalize)]
public Object Tag { get; set; }

Visual C++

[LocalizabilityAttribute(LocalizationCategory::NeverLocalize)]
public:
property Object^ Tag {
    Object^ get ();
    void set (Object^ value);
}

JScript

public function get Tag () : Object
public function set Tag (value : Object)

XAML Property Element Usage

<object>
  <object.Tag>
    <Object .../>
  </object.Tag>
</object>

Property Value

Type: System..::.Object
The intended value. This property has no default value.

Dependency Property Information

Identifier field	TagProperty
Metadata properties set to true	None

Remarks

This property is analogous to Tag properties in other Microsoft programming models, such as Microsoft Visual Basic for Applications (VBA) or Windows Forms. Tag is intended to provide a pre-existing property location where you can store some basic custom information about any FrameworkElement without requiring you to subclass an element.

Because this property takes an object, you would need to use the property element usage in order to set the Tag property in Extensible Application Markup Language (XAML) to anything other than an object with a known and built-in type converter, such as a string. Objects used in this manner are typically not within the standard Windows Presentation Foundation (WPF) namespaces and therefore may require namespace mapping to the external namespace in order to be introduced as XAML elements. For details, see XAML Namespaces and Namespace Mapping and XAML and Custom Classes.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

Version Information

.NET Framework

Supported in: 3.5, 3.0

Reference

FrameworkElement Class

FrameworkElement Members

System.Windows Namespace

Name