System.Resources.SatelliteContractVersionAttribute Class

Summary

Instructs the ResourceManager to ask for a particular version of a satellite assembly to simplify updates of the main assembly of an application.

C# Syntax:

[AttributeUsage(AttributeTargets.Assembly)] public sealed class SatelliteContractVersionAttribute : Attribute

The SatelliteContractVersionAttribute establishes a contract between a main assembly and all its satellites. When the ResourceManager looks up resources, it explicitly loads the satellite version specified by this attribute on the main assembly, allowing a layer of indirection to facilitate versioning scenarios.

When the main assembly is updated, its assembly version number is incremented. However, you might not want to ship new copies of your satellite assemblies if the existing ones are sufficient and compatible with the newer version of your product. In this case, increment the main assembly's version number but leave the satellite contract version number the same. The ResourceManager will use your existing satellite assemblies.

If you need to revise a satellite assembly but not the main assembly, you must increment the version number on your satellite. In this case, ship a policy assembly along with your satellite assembly stating that your new satellite assembly has backward compatibility with your old satellite assembly. The ResourceManager will still use the old contract number written into your main assembly; however, the loader will bind to the satellite assembly version as specified by the policy assembly.

A publisher policy assembly is the way in which a vendor of a shared component makes a compatibility statement about a particular version of a released assembly. A publisher policy assembly is a strongly named assembly with a name in the format policy.<major>.<minor>.<ComponentAssemblyName> , and is registered in the the conceptual topic at MSDN: globalassemblycache (GAC). The publisher policy is generated from an XML configuration file (see ) by using the tool. The assembly linker is used with the /link option to link the XML configuration file to a manifest assembly, that is then stored in the GAC. The publisher policy assemblies can be used when a vendor ships a maintenance release (Service Pack) that contains bug fixes.

Note Apply this attribute to your main assembly, passing it the version number of the satellite assembly that will work with this version of the main assembly.

System.Resources Namespace

System.Resources.SatelliteContractVersionAttribute Member List:

Public Constructors

ctor #1

Initializes a new instance of the SatelliteContractVersionAttribute class.

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.
Version	Read-only Gets the version of the satellite assemblies with the required resources.

Public Methods

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.
GetType (inherited from System.Object)	See base class member description: System.Object.GetType Derived from System.Object, the primary base class for all objects.
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.Object
• System.Attribute
• System.Resources.SatelliteContractVersionAttribute

System.Resources.SatelliteContractVersionAttribute Member Details

Summary

Initializes a new instance of the SatelliteContractVersionAttribute class.

C# Syntax:

public SatelliteContractVersionAttribute(    string version );

version

A String with the version of the satellite assemblies to load.

Exceptions

Exception Type	Condition
ArgumentNullException	The version parameter is null.

The current constructor initializes the SatelliteContractVersionAttribute.Version property with the version parameter.

Return to top

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;}

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

Summary

Gets the version of the satellite assemblies with the required resources.

C# Syntax:

public string Version {get;}

The current property indicates the version of the satellite assemblies that will be used with the main assembly marked with this attribute.

Return to top

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

Inherited
See base class member description: System.Object.Finalize

C# Syntax:

~SatelliteContractVersionAttribute();

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

Return to top

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

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

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.

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

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 );

obj

An Object to compare with this instance of Attribute.

Return Value:

true if this instance equals obj; otherwise, false.

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

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

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