Share via


CommandViewModel Class

Definition

Contains information about a cmdlet's Shard ParameterSet, ParameterSets, Parameters, Common Parameters and error message.

public ref class CommandViewModel : System::ComponentModel::INotifyPropertyChanged
public class CommandViewModel : System.ComponentModel.INotifyPropertyChanged
type CommandViewModel = class
    interface INotifyPropertyChanged
Public Class CommandViewModel
Implements INotifyPropertyChanged
Inheritance
CommandViewModel
Implements

Properties

AreCommonParametersExpanded

Gets or sets a value indicating whether the common parameters are expanded

CommonParameters

Gets the CommonParameters parameter.

CommonParametersHeight

Gets or sets the height for common parameters that will depend on CommonParameterVisibility

CommonParameterVisibility

Gets the CommonParameterVisibility parameter.

DetailsTitle

Gets the title for the cmdlet details

ImportModuleMessage

Gets the message to be displayed when the cmdlet belongs to a module that is not imported

IsImported

Gets a value indicating whether the cmdlet comes from a module which is imported

ModuleName

Gets the module path if it is not null or empty, or the name otherwise

ModuleQualifyCommandName

Gets or sets a value indicating whether the command name should be qualified by the module in GetScript

Name

Gets the Name parameter.

NoParameterVisibility

Gets the visibility for the control displayed when there are no parameters

NotImportedVisibility

Gets the visibility for the control displayed when the module is not imported

ParameterSets

Gets the ParameterSets parameter.

ParameterSetTabControlVisibility

Gets the visibility for the tab control displaying several ParameterSetControl. This is displayed when there are more than 1 parameter sets.

ParentModule

Gets the module containing this cmdlet in the GUI.

SelectedParameterSet

Gets or sets the SelectedParameterSet parameter.

SelectedParameterSetAllMandatoryParametersHaveValues

Gets or sets a value indicating whether the selected parameter set has all mandatory parameters valid. If there is no selected parameter set this value is true

SingleParameterSetControlVisibility

Gets the visibility for the single ParameterSetControl displayed when there is only 1 parameter set

ToolTip

Gets Tooltip string for the cmdlet

Methods

GetScript()

Gets the builded PowerShell script.

OpenHelpWindow()

Showing help information for current actived cmdlet.

Events

HelpNeeded

Indicates the command needs to display the help for a command

ImportModule

Indicates a module needs to be imported

PropertyChanged

PropertyChanged Event

Applies to