Article
11/17/2011

SatelliteContractVersionAttribute Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

Inheritance Hierarchy

System.Object
System.Attribute
System.Resources.SatelliteContractVersionAttribute

Namespace: System.Resources
Assembly: mscorlib (in mscorlib.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Assembly, AllowMultiple := False)> _
<ComVisibleAttribute(True)> _
Public NotInheritable Class SatelliteContractVersionAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Assembly, AllowMultiple = false)]
[ComVisibleAttribute(true)]
public sealed class SatelliteContractVersionAttribute : Attribute

The SatelliteContractVersionAttribute type exposes the following members.

Constructors

	Name	Description
	SatelliteContractVersionAttribute	Initializes a new instance of the SatelliteContractVersionAttribute class.

Top

Properties

	Name	Description
	Version	Gets the version of the satellite assemblies with the required resources.

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

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.

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.

Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows CE Platform Note: Although the .NET Compact Framework supports SatelliteContractVersionAttribute, its implementation is reserved for a future version.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

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