This documentation is archived and is not being maintained.

VCCustomBuildRule Interface

Interface to access custom build rules and custom build rule files.

Namespace:  Microsoft.VisualStudio.VCProjectEngine
Assembly:  Microsoft.VisualStudio.VCProjectEngine (in Microsoft.VisualStudio.VCProjectEngine.dll)

public interface VCCustomBuildRule

The VCCustomBuildRule type exposes the following members.

Public propertyAdditionalDependenciesGets or sets additional, configuration-specific items to add to the link line, such as comdlg32.lib or kernel32.lib.
Public propertyAdditionalOptionsGets or sets options to add to the end of the command line immediately before the file name(s). An example is if an option is not supported in the object model.
Public propertyBatchingSeparatorGets or sets the text to insert between input file names when a custom build rule supports file batching.
Public propertyCommandLineGets or sets a command line for the build event tool to run.
Public propertyDisplayNameGets or sets the full name of the object.
Public propertyExecutionDescriptionGets or sets the text that is displayed in the output window prior to executing the command line during a build.
Public propertyFileExtensionsGets or sets the file extensions used to associate the build rule with new files added to the project.
Public propertyNameGets or sets the name of the build rule.
Public propertyOutputsGets or sets the output files the custom build step generates.
Public propertyPropertiesGets the collection of properties for the object.
Public propertyShowOnlyRulePropertiesGets or sets a value indicating whether the build rule's user properties are shown in the property grid.
Public propertySupportsFileBatchingGets or sets a value indicating whether the command line-inputs are evaluated to all the files that can be batched into a single command-line execution (excludes files with file properties set).
Public propertyTargetRuleGets whether to use the target rule.

Public methodAddBooleanPropertyAdds a Boolean property to the custom build rule with the given name.
Public methodAddEnumPropertyAdds an enumeration property to the custom build rule with the given name.
Public methodAddIntegerPropertyAdds an integer property to the custom build rule with the given name.
Public methodAddStringPropertyAdds a string property to the custom build rule with the given name.
Public methodRemovePropertyRemoves the given property from the custom build rule.