Class StringParam

The class for an string parameter.

Inheritance
System.Object
BaseLaunchParam
StringParam
Implements
IEditableParameter
System.ComponentModel.INotifyPropertyChanged
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Phoenix.Controls.AutoGeneratedUI.LaunchParameters
Assembly: Phoenix.Controls.LaunchParameters.dll
Syntax
public class StringParam : BaseLaunchParam, ILaunchParameter, INotifyPropertyChanged

Constructors

View Source

StringParam()

Initializes a new instance of the StringParam class.

Declaration
public StringParam()
View Source

StringParam(String, String)

Initializes a new instance of the StringParam class.

Declaration
public StringParam(string factoryName, string name)
Parameters
Type Name Description
System.String factoryName

The factory name to use.
System.String name

The name to use.
View Source

StringParam(String, String, String)

Initializes a new instance of the StringParam class.

Declaration
public StringParam(string factoryName, string name, string startingValue)
Parameters
Type Name Description
System.String factoryName

The factory name to use.
System.String name

The name to use.
System.String startingValue

The starting value to use.

Properties

View Source

CommandLine

Gets or sets the command line for the parameter.

Declaration
public override string CommandLine { get; set; }
Property Value
Type Description
System.String
Overrides
View Source

CommandLineFormat

Gets or sets the command line format string.

Declaration
public string CommandLineFormat { get; set; }
Property Value
Type Description
System.String
View Source

Comment

Gets or sets the comment for the parameter.

Declaration
public string Comment { get; set; }
Property Value
Type Description
System.String
View Source

DisplayName

Declaration
public string DisplayName { get; }
Property Value
Type Description
System.String
View Source

DisplayType

Gets the display type for the parameter.

Declaration
public ParameterDisplayType DisplayType { get; }
Property Value
Type Description
ParameterDisplayType
View Source

FactoryName

Gets or sets the factory name.

Declaration
public override string FactoryName { get; set; }
Property Value
Type Description
System.String
Overrides
View Source

FlagName

Gets or sets the flag name. If null, the command line will not include any flag.

Declaration
public string FlagName { get; set; }
Property Value
Type Description
System.String
View Source

Name

Gets or sets the name.

Declaration
public override string Name { get; set; }
Property Value
Type Description
System.String
Overrides
View Source

Value

Gets or sets the value of the parameter.

Declaration
public string Value { get; set; }
Property Value
Type Description
System.String
View Source

ValueType

Declaration
public Type ValueType { get; }
Property Value
Type Description
System.Type

Methods

View Source

Configure(IDevice, IApplication, LaunchConfiguration)

Configures a new launch for the parameter.

Declaration
public override LaunchParameterDeviceConfiguration Configure(IDevice device, IApplication application, LaunchConfiguration config)
Parameters
Type Name Description
IDevice device

The target device.
IApplication application

The target application (on the device specified).
LaunchConfiguration config

The launch configuration.
Returns
Type Description
LaunchParameterDeviceConfiguration

A new launch parameter configuration for this parameter.
Overrides
View Source

ShouldSerializeCommandLine()

Gets a value indicating whether or not the CommandLine property should be serialized.

Declaration
public override bool ShouldSerializeCommandLine()
Returns
Type Description
System.Boolean

Whether or not the CommandLine property should be serialized.
Overrides

Events

View Source

PropertyChanged

Property changed event required for INotifyPropertyChanged support

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

IEditableParameter
System.ComponentModel.INotifyPropertyChanged