VObject

VObject class

VObject class.

Constructors

NameDescription
constructor()Default Constructor.
constructor(bool)Constructs from a bool value.
constructor(number)Constructs from a number value.
constructor(string)Constructs from a string value.
constructor(Date)Constructs from a Date value.
constructor(Color)Constructs from a Color value.

Methods

MethodDescription
getType()Gets the VObjectType of the vobject.
isBool()Checks whether the vobject is a bool value.
isNumber()Checks whether the vobject is a number value.
isNull()Checks whether the vobject is null.
isDate()Checks whether the vobject is a Date value.
isColor()Checks whether the vobject is a Color value.
isString()Checks whether the vobject is a String value.
isReferredArea()Checks whether the vobject is a ReferredArea object.
isRange()Checks whether the vobject is a Range object.
isObject()Checks whether the vobject is an object pointer.
toBool()Gets the bool value.
toNumber()Gets the number value.
toString()Gets the string value.
toDate()Gets the Date value.
toColor()Gets the Color value.
toReferredArea()Gets the ReferredArea object.
toRange()Gets the Range object.

constructor()

Default Constructor.

constructor();

constructor(bool)

Constructs from a bool value.

constructor(value: boolean);

Parameters:

ParameterTypeDescription
valuebooleanThe bool value.

constructor(number)

Constructs from a number value.

constructor(value: number);

Parameters:

ParameterTypeDescription
valuenumberThe number value.

constructor(string)

Constructs from a string value.

constructor(value: string);

Parameters:

ParameterTypeDescription
valuestringThe string value.

constructor(Date)

Constructs from a Date value.

constructor(value: Date);

Parameters:

ParameterTypeDescription
valueDateThe Date value.

constructor(Color)

Constructs from a Color value.

constructor(value: Color);

Parameters:

ParameterTypeDescription
valueColorThe Color value.

getType()

Gets the VObjectType of the vobject.

getType() : VObjectType;

Returns

VObjectType

isBool()

Checks whether the vobject is a bool value.

isBool() : boolean;

isNumber()

Checks whether the vobject is a number value.

isNumber() : boolean;

isNull()

Checks whether the vobject is null.

isNull() : boolean;

isDate()

Checks whether the vobject is a Date value.

isDate() : boolean;

isColor()

Checks whether the vobject is a Color value.

isColor() : boolean;

isString()

Checks whether the vobject is a String value.

isString() : boolean;

isReferredArea()

Checks whether the vobject is a ReferredArea object.

isReferredArea() : boolean;

isRange()

Checks whether the vobject is a Range object.

isRange() : boolean;

isObject()

Checks whether the vobject is an object pointer.

isObject() : boolean;

toBool()

Gets the bool value.

toBool() : boolean;

toNumber()

Gets the number value.

toNumber() : number;

toString()

Gets the string value.

toString() : string;

toDate()

Gets the Date value.

toDate() : Date;

toColor()

Gets the Color value.

toColor() : Color;

Returns

Color

toReferredArea()

Gets the ReferredArea value.

toReferredArea() : ReferredArea;

Returns

ReferredArea

toRange()

Gets the Range value.

toRange() : Range;

Returns

Range