This documentation is archived and is not being maintained.

ClientBuildManagerParameter Class

Contains values passed to the ASP.NET compiler during precompilation.


Namespace:  System.Web.Compilation
Assembly:  System.Web (in System.Web.dll)

public class ClientBuildManagerParameter

The ClientBuildManagerParameter type exposes the following members.

Public methodClientBuildManagerParameterInitializes a new instance of the ClientBuildManagerParameter class.

Public propertyPrecompilationFlagsGets or sets the flags that determine precompilation behavior.
Public propertyStrongNameKeyContainerGets or sets the key container used during compilation.
Public propertyStrongNameKeyFileGets or sets the key file used during compilation.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

ASP.NET Web pages and code files can be precompiled to facilitate a faster response for users and allow for the deployment of the site without deploying the source code. For more information on precompiling an ASP.NET Web site, see ASP.NET Precompilation Overview.

The ClientBuildManagerParameter class stores values that are used during precompilation. The PrecompilationFlags property determines how the assembly will be built. For example, you can set PrecompilationFlags to Clean to recompile any previously compiled components, or set it to OverwriteTarget to permit the resulting assembly to overwrite any components in the target directory. The PrecompilationFlags enumerator has a FlagsAttribute attribute that allows a bitwise combination of its member values. The PrecompilationFlags property can contain more than one value from the PrecompilationFlags enumeration to specify a combination of precompilation behaviors.

Either the StrongNameKeyContainer property or the StrongNameKeyFile property is assigned a value to create a strong-named assembly. Both values do not need to be set to create a strong-named assembly.

A ClientBuildManagerParameter object is passed to the ClientBuildManager object through the ClientBuildManager constructor.

The following code example is part of a code example found in the ClientBuildManager class overview. In the example, a ClientBuildManagerParameter object is created and its values set. The resulting assembly will have a strong name based on the provided key file and will precompile according to the provided PrecompilationFlags values.

_cbmParameter = new ClientBuildManagerParameter();
_cbmParameter.PrecompilationFlags = _flags;
_cbmParameter.StrongNameKeyFile = _keyFile;

builder = new
        ClientBuildManager(_vPath, _pPath, _tPath, _cbmParameter);

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.