This class defines a control within a user-defined DeepSee dashboard widget. More...

Inheritance diagram for Control:

[legend]

Collaboration diagram for Control:

[legend]

Public Member Functions
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Public Attributes
	action
	What action to take when this control is activated. More...

	actionDisplay
	Transient display name for action. More...

	activeWhen
	Specifies when this control is enabled. More...

	activeWhenDisplay
	Transient display name for activeWhen. More...

	controlClass
	Class name of component to user for this control when <property>type</property> is "custom". More...

	displayList
	Comma-delimited list of display values for the filter. More...

	label
	Label to display for the control. More...

	location
	Specifies where to place the control. More...

	locationDisplay
	Transient display name for location. More...

	name
	Identifying name for this control. More...

	readOnly
	Indicate that this control is read only. More...

	size
	Size to apply to the control (if the control accepts a size). More...

	target
	Comma-delimited list of names of widgets to apply action to. More...

	targetProperty
	Name of property within widget to apply the action to. More...

	targetPropertyDisplay
	Display name for targetProperty. More...

	text
	Default text value for the control. More...

	timeout
	Timeout value (seconds) when <property>type</property> is "timer". More...

	title
	Title (tooltip) to display for the control. More...

	type
	General type of control to use. More...

	typeDisplay
	Transient display name for type. More...

	value
	Default value for the control. More...

	valueList
	Comma-delimited list of permitted values for the control. More...

	valueRequired
	If set to true, the control must be assigned a value. More...

Private Member Functions
_.Library.Status	CopyTo (pTarget)
	Copy contents of this control to pTarget.

_.Library.Status	CopyToDao (_.Library.DynamicObject pTarget)
	Copy contents to a dynamic object.

_.Library.Status	CopyToDef (_.DeepSee.Dashboard.Control pTarget)
	Copy contents to a structured Control definition.

Additional Inherited Members
Static Public Member Functions inherited from SerialObject
_.Library.String	LogicalToOdbc (_.Library.String val)
	Converts the serial state of this serial object to a delimited string. More...

_.Library.String	OdbcToLogical (_.Library.String val)
	Converts the value of an incoming delimited string to a serialized state. More...

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Static Public Attributes inherited from SerialObject
	ODBCDELIMITER = None
	A serial object is converted to a delimited string containing the. More...

	SERIALDELIMITER = None
	This parameter specifies the delimiter character used when created a serialized. More...

	VALIDIFNULL = None
	If true, ValidateObject will return $$$OK for instances that are null as determined by IsNull(). More...

Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...

	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...

	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Detailed Description

This class defines a control within a user-defined DeepSee dashboard widget.

Controls are used to vary the values of data source parameters (such as changing the time period to display).

Member Function Documentation

◆ OnAddToSaveSet()

_.Library.Status OnAddToSaveSet	(	_.Library.Integer	depth,
		_.Library.Integer	insert,
		_.Library.Integer	callcount
	)

This callback method is invoked when the current object is added to the SaveSet,.

either because Save() was invoked on this object or on an object that references this object. OnAddToSaveSet can modify the current object. It can also add other objects to the current SaveSet by invoking AddToSaveSet or remove objects by calling RemoveFromSaveSet.

If this method returns an error status then Save() will fail and the transaction will be rolled back.

Member Data Documentation

◆ action

action

What action to take when this control is activated.

◆ actionDisplay

actionDisplay

Transient display name for action.

◆ activeWhen

activeWhen

Specifies when this control is enabled.

◆ activeWhenDisplay

activeWhenDisplay

Transient display name for activeWhen.

◆ controlClass

controlClass

Class name of component to user for this control when <property>type</property> is "custom".

This is the name of a Zen control.
If the name does not include package, then "%ZEN.Component" is used.
If no name is provided, a default control is used.

◆ displayList

displayList

Comma-delimited list of display values for the filter.

If supplied this overrides a default list.

◆ label

label

Label to display for the control.

◆ location

location

Specifies where to place the control.

If "click" then this defines what happens when a user clicks on an item within the widget.

◆ locationDisplay

locationDisplay

Transient display name for location.

◆ name

name

Identifying name for this control.

This is used to logically identify the control.

◆ readOnly

readOnly

Indicate that this control is read only.

◆ size

size

Size to apply to the control (if the control accepts a size).

◆ target

target

Comma-delimited list of names of widgets to apply action to.

If "*", then send event to all widgets.

◆ targetProperty

targetProperty

Name of property within widget to apply the action to.

Typically this is the name of the filter being modified.

◆ targetPropertyDisplay

targetPropertyDisplay

Display name for targetProperty.

(This value is saved so that we don't have to recompute it later; the value is only used for display purposes).

◆ text

text

Default text value for the control.

◆ timeout

timeout

Timeout value (seconds) when <property>type</property> is "timer".

◆ title

title

Title (tooltip) to display for the control.

◆ type

type

General type of control to use.

If "custom", then the control specified by <property>controlClass</property> is used.

◆ typeDisplay

typeDisplay

Transient display name for type.

◆ value

value

Default value for the control.

If this starts with "@" then it is the name of a user defined-setting.

◆ valueList

valueList

Comma-delimited list of permitted values for the control.