The class ControlData accesses information about controls which was compiled from the property bag specifications in the various form files. More...

Static Public Member Functions
static int	FindProperty (int ctlType, string propName, int iCode)
	The method FindProperty locates the assignment value for a property specified via its operation code and its name within the current code block. More...

static string	GetProperty (int iCode, bool inXml=true)
	The method GetProperty returns the authored value of a property whose value code is at a specified starting offset. More...

static int	GetValue (int iCode)
	The method GetValue returns the integer value of a property whose value code starting offset is specified. More...

static int	LoadCode (int ctlRoot, bool cmpOnly=false)
	The method LoadCode loads the property code vector into the next available byte of code storage. Note that when the code vector is no longer needed the user must call the method Opcode.SetLength(iCode), where iCode was the return value of this method. More...

static string	GetFontSize (int iCode, bool inXml=true)
	The method GetFontSize returns the authored value of a Font Size property whose code starting offset is known. Note that regarding Font Size, the font units in VB6 and WinForms is Points. In XML all sizes are in logical Pixels. We typically can use 72 points/inch and 96 pixels/inch for scaling. More...

static int	ReplaceValue (int iCode, int opcode, int subcode)
	The method ReplaceValue replaces the value of a property whose value code starting offset specified. More...

static void	SaveCode (int ctlRoot, int iStart)
	The SaveCode method saves the current code block associated with a control instance in the compiled code area of that control. More...

Detailed Description

The class ControlData accesses information about controls which was compiled from the property bag specifications in the various form files.

Member Function Documentation

◆ FindProperty()

static int gmslLibrary.Services.ControlData.FindProperty	(	int	ctlType,
		string	propName,
		int	iCode
	)

static

The method FindProperty locates the assignment value for a property specified via its operation code and its name within the current code block.

Parameters

ctlType	specifies the operation code of the property.
propName	contains the name of the property.
iCode	specifies the stating offset in the code block to being the search.

Returns: If a property value is present its code starting offset is returned; else zero is returned.

◆ GetFontSize()

static string gmslLibrary.Services.ControlData.GetFontSize	(	int	iCode,
		bool	inXml = `true`
	)

static

The method GetFontSize returns the authored value of a Font Size property whose code starting offset is known. Note that regarding Font Size, the font units in VB6 and WinForms is Points. In XML all sizes are in logical Pixels. We typically can use 72 points/inch and 96 pixels/inch for scaling.

Parameters

iCode	specifies the starting offset of the value assignment code usually as obtained from the method FindProperty.
inXml	If true, use XML logical pixels. If false, use points. The default value is true.

Returns: The method returns the string representation of the Font Size.

◆ GetProperty()

static string gmslLibrary.Services.ControlData.GetProperty	(	int	iCode,
		bool	inXml = `true`
	)

static

The method GetProperty returns the authored value of a property whose value code is at a specified starting offset.

Parameters

iCode	specifies the starting offset of the value assignment code usually as obtained from the method FindProperty.
inXml	specifies how the result is to be determined. If false, the result string is simply the return value size units are in Points. If true, in XML, all sizes are in logical Pixels – i.e. 72 points/inch versus 96 pixels/inch for scaling used in Xml. The default setting is true;

Returns: A string representation of the property value.

◆ GetValue()

static int gmslLibrary.Services.ControlData.GetValue ( int iCode )

static

The method GetValue returns the integer value of a property whose value code starting offset is specified.

Parameters

iCode specifies the starting offset of the value assignment code usually as obtained from the method FindProperty.

Returns: Returns the integer value of the property.

◆ LoadCode()

static int gmslLibrary.Services.ControlData.LoadCode	(	int	ctlRoot,
		bool	cmpOnly = `false`
	)

static

The method LoadCode loads the property code vector into the next available byte of code storage. Note that when the code vector is no longer needed the user must call the method Opcode.SetLength(iCode), where iCode was the return value of this method.

Parameters

ctlRoot	The parameter ctlRoot is the root offset of the control whose data is to be accessed.
cmpOnly	The parameter cmpOnly, if true, specifies that the original compiled code only should be used, not the modified analysed code. The default is false.

Returns: The method returns the offset of the starting code byte. If the control has no code vector associated with it, then a zero is returned.

◆ ReplaceValue()

static int gmslLibrary.Services.ControlData.ReplaceValue	(	int	iCode,
		int	opcode,
		int	subcode
	)

static

The method ReplaceValue replaces the value of a property whose value code starting offset specified.

Parameters

iCode	specifies the starting offset of the value assignment code usually as obtained from the method FindProperty.
opcode	specifies the operation code of the new value.
subcode	specifies the subcode value of the new code.

Returns: There is no requirement that the size of the relacement code be the same as the size of the original code; therefore, the method returns the final size of the global code block.

◆ SaveCode()

static void gmslLibrary.Services.ControlData.SaveCode	(	int	ctlRoot,
		int	iStart
	)

static

The SaveCode method saves the current code block associated with a control instance in the compiled code area of that control.

Parameters

ctlRoot	specifies the root offset of the control whose code vector is to be saved.
iStart	specifies the start in the global code block of the code to be saved.

The documentation for this class was generated from the following file:

C:/gmProducts/gmStudio_dev/src/gmslAPI/gmslLibrary/ControlData.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ FindProperty()

◆ GetFontSize()

◆ GetProperty()

◆ GetValue()

◆ LoadCode()

◆ ReplaceValue()

◆ SaveCode()