Detokenise Properties

MSBuild Extension Pack

Detokenise Properties MSBuild Extension Pack Help 4.0.12.0

The Detokenise type exposes the following members.

Properties

  Name Description
Public property CommandLineValues
Sets the replacement values provided via the command line. The format is token1=value1#~#token2=value2 etc.
Public property DisplayFiles
Set to true for files being processed to be output to the console.
Public property FilesDetokenised
Gets the files detokenised count. [Output]
Public property FilesProcessed
Gets the files processed count. [Output]
Public property ForceWrite
If this is set to true, then the file is re-written, even if no tokens are matched. this may be used in the case when the user wants to ensure all file are written with the same encoding.
Public property IgnoreUnknownTokens
Specifies whether to ignore tokens which are not matched. Default is false.
Public property ProjectFile
Sets the MSBuild file to load for token matching. Defaults to BuildEngine.ProjectFileOfTaskNode
Public property ReplacementValues
Sets the replacement values.
Public property ReportUnusedTokens
Set to true when running a Report to see which tokens are not used in any files scanned. Default is false.
Public property SearchAllStores
Specifies whether to search in the ReplacementValues, CommandLineValues and the ProjectFile for token values. Default is false.
Public property Separator
Sets the separator to use to split the CommandLineValues. The default is #~#
Public property TargetFiles
Sets the TargetFiles.
Public property TargetPath
Sets the TargetPath.
Public property TextEncoding
The file encoding to write the new file in. The task will attempt to default to the current file encoding. If TargetFiles is specified, individual encodings can be specified by providing an Encoding metadata value.
Public property TokenExtractionPattern
Specifies the regular expression to use to extract the token name from the TokenPattern provided. The default pattern is (?<=\$\()[0-9a-zA-Z-._]+(?=\)), i.e it will extract token from $(token)
Public property TokenPattern
Specifies the regular expression format of the token to look for. The default pattern is \$\([0-9a-zA-Z-._]+\) which equates to $(token)
Public property TokenReport
ItemGroup containing the Tokens (Identity) and Files metadata containing all the files in which the token can be found.
Public property UnusedTokens
Itemgroup containing the tokens which have been provided but not found in the files scanned. ReportUnusedTokens must be set to true to use this.
Top
See Also

Reference