public class |source

edit

Class used for retrieving and referencing user input

Constructor Summary

Public Constructor
public	constructor(pEditVariable: String) Used to retrieve user-specified values from the top of the pane (symbol and date correspond to the two default options at the top of a pane)

Member Summary

Public Members
public get	number: number Returns the user input as a number
public get	value: string Returns the user input as a string
public set	value: string Sets the user input value to the provided string

Private Members
private	_number: *
private	fEditEnum: *
private	fEditName: *
private	fEditType: *

Public Constructors

public constructor(pEditVariable: String) source

Used to retrieve user-specified values from the top of the pane (symbol and date correspond to the two default options at the top of a pane)

Params:

Name	Type	Attribute	Description
pEditVariable	String	optional

Example:

// Specific v9 keywords ("symbol" and "date")
let symbol = new v9.edit("symbol").value; //gets the symbol from the default textbox at the top of the pane
let date = new v9.edit("date").value; //gets the date from the default textbox at the top of the pane

// Custom user input keywords can be anything else
let quantity = new v9.edit("QUANTITY"); //gets the string the user inputs into a custom 'QUANTITY' textbox at the top of the pane
let quantity = new v9.edit("QUANTITY").value; //gets the string the user inputs into a custom 'QUANTITY' textbox at the top of the pane
let quantity = new v9.edit("QUANTITY").number; //gets the number the user inputs into a custom 'QUANTITY' textbox at the top of the pane

Public Members

public get number: number source

Returns the user input as a number

public get value: string source

Returns the user input as a string

public set value: string source

Sets the user input value to the provided string

edit

Constructor Summary

Member Summary

Public Constructors

public constructor(pEditVariable: String) source

Params:

Example:

Public Members

public get number: number source

public get value: string source

public set value: string source

Private Members

private _number: * source

private fEditEnum: * source

private fEditName: * source

private fEditType: * source