System.Runtime.Remoting.Proxies.ProxyAttribute Class

Assembly: Mscorlib.dll
Namespace: System.Runtime.Remoting.Proxies
Summary
Indicates that an object type requires a custom proxy.
C# Syntax:
[AttributeUsage(AttributeTargets.Class)]
public class ProxyAttribute : Attribute
Remarks
Apply the current attribute to types that need custom proxies.
See also:
System.Runtime.Remoting.Proxies Namespace | RealProxy

System.Runtime.Remoting.Proxies.ProxyAttribute Member List:

Public Constructors
ctor #1 Default constructor. This constructor is called by derived class constructors to initialize state in this type.
Initializes a new instance of the ProxyAttribute class with default values.
Public Properties
TypeId
(inherited from System.Attribute)
Read-only

See base class member description: System.Attribute.TypeId


When implemented in a derived class, gets a unique identifier for this Attribute.
Public Methods
CreateInstance Creates either an uninitialized MarshalByRefObject or a transparent proxy, depending on whether the specified type can exist in the current context.
CreateProxy Creates an instance of a remoting proxy for a remote object described by the specified ObjRef, and located on the server.
Equals
(inherited from System.Object)
See base class member description: System.Object.Equals

Derived from System.Object, the primary base class for all objects.
GetHashCode
(inherited from System.Attribute)
See base class member description: System.Attribute.GetHashCode


Returns the hash code for this instance.
GetPropertiesForNewContext Supports the Shared Source CLI infrastructure and is not intended to be used directly from your code
GetType
(inherited from System.Object)
See base class member description: System.Object.GetType

Derived from System.Object, the primary base class for all objects.
IsContextOK Supports the Shared Source CLI infrastructure and is not intended to be used directly from your code
IsDefaultAttribute
(inherited from System.Attribute)
See base class member description: System.Attribute.IsDefaultAttribute


When overridden in a derived class, returns an indication whether the value of this instance is the default value for the derived class.
Match
(inherited from System.Attribute)
See base class member description: System.Attribute.Match


When overridden in a derived class, returns a value indicating whether this instance equals a specified object.
ToString
(inherited from System.Object)
See base class member description: System.Object.ToString

Derived from System.Object, the primary base class for all objects.
Protected Methods
Finalize
(inherited from System.Object)
See base class member description: System.Object.Finalize

Derived from System.Object, the primary base class for all objects.
MemberwiseClone
(inherited from System.Object)
See base class member description: System.Object.MemberwiseClone

Derived from System.Object, the primary base class for all objects.

Hierarchy:


System.Runtime.Remoting.Proxies.ProxyAttribute Member Details

ctor #1
Summary
Initializes a new instance of the ProxyAttribute class with default values.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.
C# Syntax:
public ProxyAttribute();

Return to top


Property: TypeId (read-only)
Inherited
See base class member description: System.Attribute.TypeId

Summary
When implemented in a derived class, gets a unique identifier for this Attribute.
C# Syntax:
public virtual object TypeId {get;}
Remarks
As implemented, this identifier is merely the Type of the attribute. However, it is intended that the unique identifier be used to identify two attributes of the same type.

Return to top


Method: CreateInstance(
   Type serverType
)
Summary
Creates either an uninitialized MarshalByRefObject or a transparent proxy, depending on whether the specified type can exist in the current context.
C# Syntax:
public virtual MarshalByRefObject CreateInstance(
   Type serverType
);
Parameters:

serverType

The object type to create an instance of.

Return Value:
An unitialized MarshalByRefObject or a transparent proxy.

Return to top


Method: CreateProxy(
   ObjRef objRef,
   Type serverType,
   object serverObject,
   Context serverContext
)
Summary
Creates an instance of a remoting proxy for a remote object described by the specified ObjRef, and located on the server.
C# Syntax:
public virtual RealProxy CreateProxy(
   ObjRef objRef,
   Type serverType,
   object serverObject,
   Context serverContext
);
Parameters:

objRef

The object reference to the remote object for which to create a proxy.

serverType

The type of the server where the remote object is located.

serverObject

The server object.

serverContext

The context in which the server object is located.

Return Value:
The new instance of remoting proxy for the remote object described in the specified ObjRef.
Remarks


Note The current method is called when a proxy is created out of an ObjRef instance that references a class that is marked with the ProxyAttribute attribute. Therefore the method is used only when an ObjRef is received from a return or parameter on a call, or during the activation of a client-activated object. The ProxyAttribute is not used for well-known object types.

Return to top


Method: Equals(
   object obj
)
Inherited
See base class member description: System.Object.Equals
C# Syntax:
public virtual bool Equals(
   object obj
);

For more information on members inherited from System.Object click on the link above.

Return to top


Method: Finalize()
Inherited
See base class member description: System.Object.Finalize
C# Syntax:
~ProxyAttribute();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: GetHashCode()
Inherited
See base class member description: System.Attribute.GetHashCode

Summary
Returns the hash code for this instance.
C# Syntax:
public override int GetHashCode();
Return Value:
A 32-bit signed integer hash code.

Return to top


Method: GetPropertiesForNewContext(
   IConstructionCallMessage msg
)
Summary
Supports the Shared Source CLI infrastructure and is not intended to be used directly from your code
C# Syntax:
public void GetPropertiesForNewContext(
   IConstructionCallMessage msg
);
Parameters:

msg

Implements:
IContextAttribute.GetPropertiesForNewContext

Return to top


Method: GetType()
Inherited
See base class member description: System.Object.GetType
C# Syntax:
public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: IsContextOK(
   Context ctx,
   IConstructionCallMessage msg
)
Summary
Supports the Shared Source CLI infrastructure and is not intended to be used directly from your code
C# Syntax:
public bool IsContextOK(
   Context ctx,
   IConstructionCallMessage msg
);
Parameters:

ctx

msg

Implements:
IContextAttribute.IsContextOK

Return to top


Method: IsDefaultAttribute()
Inherited
See base class member description: System.Attribute.IsDefaultAttribute

Summary
When overridden in a derived class, returns an indication whether the value of this instance is the default value for the derived class.
C# Syntax:
public virtual bool IsDefaultAttribute();
Return Value:
true if this instance is the default attribute for the class; otherwise, false.
Remarks
The default implementation of this class returns false, and must be implemented in the derived class to be useful to that class.

The implementation of this method in a derived class compares the value of this instance to a standard, default value obtained by some means, then returns a Boolean value that indicates whether the value of this instance is equal to the standard. The standard value is typically coded as a constant in the implementation, or stored programmatically in a field used by the implementation.

Return to top


Method: Match(
   object obj
)
Inherited
See base class member description: System.Attribute.Match

Summary
When overridden in a derived class, returns a value indicating whether this instance equals a specified object.
C# Syntax:
public virtual bool Match(
   object obj
);
Parameters:

obj

An Object to compare with this instance of Attribute.

Return Value:
true if this instance equals obj; otherwise, false.
Remarks
This method determines if one Attribute equals another. Its default implementation is the same as Attribute.Equals, which performs a value and reference comparison. Override this method to implement support for attribute values, such as flags or bitfields, that consist of components that are meaningful in themselves. For example, consider an attribute whose value is a binary field divided into a bitfield of flags. Two instances of this attribute have one flag in set in common while all the other flags differ. The Equal method cannot determine that the two instances have the same flag set, but the Match method can.

Return to top


Method: MemberwiseClone()
Inherited
See base class member description: System.Object.MemberwiseClone
C# Syntax:
protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: ToString()
Inherited
See base class member description: System.Object.ToString
C# Syntax:
public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top


Top of page

Copyright (c) 2002 Microsoft Corporation. All rights reserved.