Class %CSP.UI.Portal.Dialog.Broadcast

class %CSP.UI.Portal.Dialog.Broadcast extends %CSP.UI.Portal.Dialog.WizardTemplate

Broadcast message to principal devices of processes.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
4		8

Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	align	aux	backgroundTimerInterval
cellAlign	cellSize	cellStyle	cellVAlign
children	composite	containerStyle	cssLevel
dialogTitle	disabled	disabledStyle	dragAndDrop
dragEnabled	dropEnabled	enclosingClass	enclosingStyle
error	groupClass	groupStyle	height
hidden	hideApplyButton	hint	hintClass
hintStyle	id	index	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	name	onafterdrag	onbeforedrag
onclick	ondrag	ondrop	onhide
onrefresh	onshow	onupdate	parent
showLabel	slice	title	tuple
useSVG	useSoftModals	valign	visible
width	window	zenPersistentPopup

Methods
%%OIDGet	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%AddImportedComponents	%AddToSaveSet	%ApplyURLParms
%Attr	%BindExport	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%DrawAutoLogout	%DrawClassDefinitions	%DrawComponentHTML	%DrawHTML
%DrawHTMLPage	%DrawJSStrings	%DrawObjectDefinitions	%DrawTitle
%EnclosingDivId	%EndBackgroundMethod	%EndScript	%Eval
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetLinks
%GetPageName	%GetParameter	%GetValueById	%GetValueByName
%GetXMLName	%IsA	%IsModified	%Link
%LinkCSS	%LinkScript	%MakeId	%New
%NormalizeObject	%ObjectModified	%OnAddToPageAfter	%OnAddToPageBefore
%OnAfterCreatePage	%OnBeforeCreatePage	%OnCreateApplication	%OnCreatePage
%OnDetermineCSSLevel	%OnDrawEnclosingDiv	%OnDrawHTMLBody	%OnDrawHTMLHead
%OnDrawHTMLMeta	%OnDrawObjectProperties	%OnFinishBackgroundTask	%OnGetSubtitle
%OnGetTitle	%OnMonitorBackgroundTask	%OnMutateChildren	%OnObjectSynch
%OnPreHTTP	%OnSubmit	%OnUseSoftModals	%OnZENDeserialize
%OriginalNamespace	%PackageName	%QuoteValue	%QuoteValueL10N
%RemoveChild	%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet
%RunBackgroundMethod	%Self	%SerializeObject	%SetBackgroundMethodStatus
%SetErrorById	%SetErrorByName	%SetModified	%SetValueById
%SetValueByName	%SetValuesByName	%StartScript	%ValidateObject
%ZENVersion	BroadcastMsg	ConvertParameter	Decrypt
DrawPageTitle	Encrypt	EscapeHTML	EscapeURL
HyperEventBody	HyperEventCall	HyperEventFrame	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsEnabled
IsPrivate	Link	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	QuoteJS	RewriteURL
ShowError	StartTimer	StopTimer	ThrowError
UnescapeHTML	UnescapeURL	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType	ZStripW	addChild
addChildAfter	addChildBefore	adjustSize	btnApply
btnOK	canFinish	canGoBack	canGoNext
cancelPopup	childrenMutated	correctIELayering	createComponent
createComponentNS	ctrlKeyDown	deleteComponent	dialogApply
dialogCancel	dialogFinish	dialogTitleGet	disableButtons
doBroadcast	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	dropHandler	dropStartHandler	endModal
exposeComponent	findElement	fireOnLoadEvent	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction	formValidationHandler
getChildIndex	getComponent	getComponentById	getDialogValue
getEnclosingDiv	getHidden	getHintElement	getLabelElement
getOpener	getProperty	getSettings	getType
gotoPage	hasMultiplePages	invokeSuper	isOfType
launchPopupWindow	makeId	nextPage	onCreate
onDelete	onDisplayHandler	onEndModalHandler	onPopupAction
onRefreshContents	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	ondialogCancel	ondialogFinish
ondialogStart	ondisabledHandler	onfinishHandler	onkeydownHandler
onkeyupHandler	onlayoutHandler	onloadHandler	onlogoutHandler
onoverlayHandler	onresizeHandler	onstartHandler	onunloadHandler
onupdateHandler	popupActionHandler	previousPage	refreshContents
removeChild	render	renderContents	renderSVG
resetMsg	setComponentId	setHidden	setOverlayMode
setProperty	setPropertyAll	setTraceOption	showDocumentation
showHelp	showMsg	startModal	startProgressBar
stopProgressBar	updateState

Parameters

• parameter APPLICATION = "%CSP.UI.Portal.Application";

Class name of application this page belongs to.

• parameter APPLYBUTTON = 0;

If true, then this dialog displays an Apply button.

• parameter CSPURL = "/csp/sys/op/%CSP.UI.Portal.Dialog.Broadcast.cls";

This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.

• parameter PAGENAME = "Broadcast Message";

Displayed name of this page.

Methods

• method %OnAfterCreatePage() as %Status

This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.

• method %OnGetSubtitle() as %String

Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.

• method %OnGetTitle() as %String

Get the (localized) title string for the dialog. This should be implemented in a subclass.

• classmethod BroadcastMsg(Msg As %String, selectedRows As %String) as %String [ ZenMethod ]

Send message

• classmethod DrawPageTitle(pSeed As %String) as %Status

• method doBroadcast() [ Language = javascript ]

• method getDialogValue() [ Language = javascript ]

Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.

• method onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.


[BASEXML] > [%CSP] > [UI] > [Portal] > [Dialog] > [Broadcast]		Private Storage