ShellCommandWriteAssemblyCommandList Method (TextWriter, Assembly, String)

public static void WriteAssemblyCommandList(
	TextWriter writer,
	Assembly assembly,
	string commandFormat
)

Public Shared Sub WriteAssemblyCommandList ( 
	writer As TextWriter,
	assembly As Assembly,
	commandFormat As String
)

Dim writer As TextWriter
Dim assembly As [Assembly]
Dim commandFormat As String

ShellCommand.WriteAssemblyCommandList(writer, 
	assembly, commandFormat)

public:
static void WriteAssemblyCommandList(
	TextWriter^ writer, 
	Assembly^ assembly, 
	String^ commandFormat
)

Parameters

writer

Type: System.IOTextWriter
The TextWriter to write the commands to.

assembly

Type: System.ReflectionAssembly
The assembly that contains the shell commands.

commandFormat

Type: SystemString
The format string used to format a command's name and description, for example "{0,13} : {1}".

The commandFormat should have two placeholders, which are used for the command name and description respectively.

This method writes a list of all shell command names and their descriptions to writer.

A command's name is retrieved from its ShellCommandAttribute attribute, and the description is retrieved from its DescriptionAttribute attribute.

If writer is a LineWrappingTextWriter, the writer's indent will be reset before every command. It is recommended to set the Indent property to a value appropriate for your commandFormat.

Reference