Cicode Programming Reference > Cicode Function Categories > Display Functions Introduction > Display Functions

Display Functions

Following are functions relating to the display of graphics pages and objects:

DspAnCreateControlObject

Creates a new instance of an ActiveX object. If the object already exists for the given Animation Point Number, then that object will be used (a new object is not created).

DspAnFree

Frees (removes) an AN from the current page.

DspAnGetArea

Gets the area configured for an object at a specific AN (animation-point number).

DspAnGetMetadata

Retrieves the field value of the specified metadata entry.

DspAnGetMetadataAt

Retrieves metadata information at the specified index.

DspAnGetPos

Gets the x and y coordinates of an AN (animation-point number).

DspAnGetPrivilege

Gets the privileges configured for an object at a specific AN (animation-point number).

DspAnInfo

Gets information on the state of the animation at an AN.

DspAnInRgn

Checks if an AN is within a specified region.

DspAnMove

Moves an AN.

DspAnMoveRel

Moves an AN relative to its current position.

DspAnNew

Creates an AN.

DspAnNewRel

Creates an AN relative to another AN.

DspAnSetMetadata

Non-blocking function, that sets the value of the specified metadata entry.

DspAnSetMetadataAt

Sets the value of a metadata entry.

DspBar

Displays a bar graph at an AN.

DspBmp

Displays a bitmap at a specified AN.

DspButton

Displays a button at an AN and puts a key into the key command line (when the button is selected).

DspButtonFn

Displays a button at an AN and calls a function when the button is selected.

DspChart

Displays a chart at an AN.

DspCol

DspCol is deprecated in this version.

DspDel

Deletes the objects at an AN.

DspDelayRenderBegin

Delays screen updating until DspDelayRenderEnd() is called.

DspDelayRenderEnd

Ends the screen update delay set by DspDelayRenderBegin().

DspDirty

Forces an update to an AN.

DspError

Displays an error message at the prompt AN.

DspFile

Defines the screen attributes for displaying a text file.

DspFileGetInfo

Gets the attributes of a file to screen display.

DspFileGetName

Gets the name of the file being displayed in the display "window".

DspFileScroll

Scrolls a file (displayed in the display "window") by a number of characters.

DspFileSetName

Sets the name of the file to display in the display "window".

DspFont

Creates a font.

DspFontHnd

Gets a font handle.

DspFullScreen

Enables or disables the fullscreen mode of the active window.

DspGetAnBottom

Gets the bottom extent of the object at the specified AN.

DspGetAnCur

Gets the current AN.

DspGetAnExtent

Gets the extent of the object at a specified AN.

DspGetAnFirst

Returns the first AN on the current page.

DspGetAnFromPoint

Gets the AN of the object at a specified set of screen coordinates.

DspGetAnHeight

Gets the height of the object at a specified AN.

DspGetAnLeft

Gets the left extent of the object at the specified AN.

DspGetAnNext

Returns the AN following a specified AN.

DspGetAnRight

Gets the right extent of the object at the specified AN.

DspGetAnTop

Gets the top extent of the object at the specified AN.

DspGetAnWidth

Gets the width of the object at a specified AN.

DspGetEnv

Gets a page environment variable.

DspGetMouse

Gets the mouse position.

DspGetMouseOver

Determines if the mouse is within the boundaries of a given AN.

DspGetNearestAn

Gets the nearest AN.

DspGetParentAn

Gets the parent animation number (if any), for the specified AN.

DspGetSlider

Gets the current position (value) of a slider at an AN.

DspGetTip

Gets the tool tip text associated with an AN.

DspGrayButton

Greys and disables a button.

DspInfo

Gets object display information from an AN.

DspInfoDestroy

Deletes an object information block created by DspInfoNew().

DspInfoField

Gets stored and real-time data for a variable tag.

DspInfoNew

Creates an object information block for an AN.

DspInfoValid

Checks if an object information block is still valid.

DspIsButtonGray

Gets the current status of a button.

DspKernel

Displays the Kernel window.

DspMarkerMove

Moves a trend or chart marker to a specified position.

DspMarkerNew

Creates a new trend marker.

DspMCI

Controls a multimedia device.

DspPlaySound

Plays a waveform (sound).

DspPopUpConfigMenu

Displays the contents of a menu node as a pop-up (context) menu, and runs the command associated with the selected menu item.

DspPopupMenu

Creates a menu consisting of a number of menu items.

DspRichText

Creates a Rich Text object at the animation point.

DspRichTextEdit

Enables/disables editing of the contents of a rich text object.

DspRichTextEnable

Enables/disables a rich text object.

DspRichTextGetInfo

Returns size information about a rich text object.

DspRichTextLoad

Loads a copy of a rich text file into a rich text object.

DspRichTextPgScroll

Scrolls the contents of a rich text object by one page length.

DspRichTextPrint

Prints the contents of a rich text object.

DspRichTextSave

Saves the contents of a rich text object to a file.

DspRichTextScroll

Scrolls the contents of a rich text object by a user defined amount.

DspRubEnd

Ends a rubber band selection.

DspRubMove

Moves a rubber band selection to the new position.

DspRubSetClip

Sets the clipping region for the rubber band display.

DspRubStart

Starts a rubber band selection (used to rescale a trend with the mouse).

DspSetSlider

Sets the current position of a slider at the specified AN.

DspSetTip

Sets tool tip text associated with an AN.

DspSetTooltipFont

Sets the font for tool tip text.

DspStatus

Sets the communication status error for a specified animation number.

DspStr

Displays a string at an AN.

DspSym

Displays a symbol at an AN.

DspSymAnm

Displays a series of animated symbols at an AN.

DspSymAnmEx

Displays a series of animated symbols at an AN.

DspSymAtSize

Displays a symbol at a scale and offset from an AN.

DspText

Displays text at an AN.

DspTipMode

Switches the display of tool tips on or off.

DspTrend

Displays a trend at an AN.

DspTrendInfo

Gets information on a trend definition.

See Also

Cicode Functions