ClientPropertyAttribute Class

Article
07/02/2014

Custom Team Foundation attribute which may be used to attribute server objects to modify the visibility for the client-side objects generated. The property name may be overridden by passing in a property name. The resulting field name will be the property name with the first character converted to its lower case form, prefixed by 'm_'. A property with Private visibility will not generate a property at all. This mechanism may be used to avoid generating extraneous properties.

Inheritance Hierarchy

System.Object
System.Attribute
Microsoft.TeamFoundation.Framework.Server.ClientPropertyAttribute

Namespace: Microsoft.TeamFoundation.Framework.Server
Assembly: Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field, AllowMultiple := False)> _
Public NotInheritable Class ClientPropertyAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = false)]
public sealed class ClientPropertyAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Property|AttributeTargets::Field, AllowMultiple = false)]
public ref class ClientPropertyAttribute sealed : public Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = false)>]
type ClientPropertyAttribute =  
    class 
        inherit Attribute 
    end

public final class ClientPropertyAttribute extends Attribute

The ClientPropertyAttribute type exposes the following members.

Constructors

	Name	Description
	ClientPropertyAttribute()
	ClientPropertyAttribute(ClientVisibility)	Constructor which specifies both the get/set visibilities as the same value.
	ClientPropertyAttribute(ClientVisibility, ClientVisibility)	Constructor which allows a specification of differing visibility for each of the get and set methods of a property.

Top

Properties

	Name	Description
	Direction	Returns the direction associated with this attribute. The default is Bidirectional.
	GetterVisibility	Returns the client visibility specified in the attribute. The default is Public.
	PropertyName	Returns the property name if one was supplied. If a property name is not supplied then the name of the property or field is used by default.
	SetterVisibility	Returns the client visibility specified in the attribute. The default is Public.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
	UseClientDefinedProperty	Specifies whether to generate a field and use it (the default), or to refer to a named Property, assumed to pre-exist on the client. This is very handy when we wish the client inheritance not to mimic the server inheritance, or when we want to insert code between the generated code and member access.

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
	_Attribute.GetTypeInfo	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
	_Attribute.GetTypeInfoCount	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
	_Attribute.Invoke	Provides access to properties and methods exposed by an object. (Inherited from Attribute.)

Top

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.

Share via