SalRibbonBarBase
PPJ.Runtime.Windows.SalRibbonBarBase
Namespace: PPJ.Runtime.Windows
Assembly: PPJ.Runtime.49 (4.9.0.0)
Base class for all RibbonBar forms.
C#
VB.NET
public class SalRibbonBarBase : C1RibbonForm, ISalForm, ISalWindow
Public Class SalRibbonBarBase
Inherits C1RibbonForm
Implements ISalForm, ISalWindow
Size: Returns/Sets the DPI used to design this form. This is the base DPI scale and it will be used to scale the form.
Freezes screen updates to the form.
Brings a window to the top of all overlapping windows.
Centers a window. If the window is a top-level window, it centers it on the desktop. If the window is a child window, it centers it on top of its parent.
Clears a window's cursor.
Parameter | Type | Description |
|---|---|---|
type | |
Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.
Disables keyboard and mouse input to a window. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.
Redraws the menu bar for a given form window or top-level table window.
Enables keyboard and mouse input to a window.
Destroys a modal dialog box and returns control to the caller of SalModalDialog.
Parameter | Type | Description |
|---|---|---|
nReturn | |
Enables screen updates to the form.
This function finds a child window of a given name in the specified window.
Parameter | Type | Description |
|---|---|---|
windowName | |
Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.
Dispatches the specified message (Window Actions) directly to the children's WindowActions event handlers, without going through Windows message loop.
Computes the number of pixels in the number of form units. Form units are a unit of measurement used by functions which move and position objects. Form units are computed using physical units (pixels) in conjunction with the window's font size.
Parameter | Type | Description |
|---|---|---|
formUnits | The number of form units. | |
vertical | If the form units are on the X axis, set this parameter to FALSE. If the form units are on the Y axis, set this parameter to TRUE. |
Return the name of a window's class as a string.
Returns an object's type.
Returns the handle of the default push button on a form window or dialog box. The default push button is the one that has the focus by default.
Returns the handle of the first child window of the specified type. You can use this function to get the handles of MDI child windows.
Parameter | Type | Description |
|---|---|---|
typeMask | One or more window types combined (using the OR (|) operator) to create a mask of child window types. |
Parameter | Type | Description |
|---|---|---|
name | | |
size | | |
enhancement | |
Parameter | Type | Description |
|---|---|---|
x | | |
y | |
Parameter | Type | Description |
|---|---|---|
text | |
Gets the name of an object.
Returns the handle of the next child window that matches a specified type.
Parameter | Type | Description |
|---|---|---|
typeMask | One or more window types combined (using the OR (|) operator) to create a mask of child window types. |
Returns the handle of an object's parent window.
Parameter | Type | Description |
|---|---|---|
name | | |
value | |
Gets the value of a named property.
Parameter | Type | Description |
|---|---|---|
name | |
Parameter | Type | Description |
|---|---|---|
width | | |
height | |
Parameter | Type | Description |
|---|---|---|
sText | | |
nMaxLen | |
Gets the text displayed in the status bar of a top-level or MDI window.
Parameter | Type | Description |
|---|---|---|
nMaxLen | |
Parameter | Type | Description |
|---|---|---|
text | | |
maxLen | |
Retrieves the text of a window.
Parameter | Type | Description |
|---|---|---|
maxLen | |
Gets a window's color.
Parameter | Type | Description |
|---|---|---|
colorIndex | |
Returns a window's current state.
Hides a window.
Causes a window to be repainted.
Determines whether a window is an instance of the specified class.
Parameter | Type | Description |
|---|---|---|
typeClass | |
Determines whether a window is enabled for mouse and keyboard input.
Determines whether a window is currently visible.
Destroys an object's system timer.
Parameter | Type | Description |
|---|---|---|
idEvent | |
Moves a window a given number of form units on the X and Y axes relative to its current position.
Computes the number of form units based on the number of pixels. Form units are a unit of measurement used by functions that move and position objects. Form units are computed using physical units (pixels) in conjunction with a window's font sizes.
Parameter | Type | Description |
|---|---|---|
numPixels | | |
vertical | If the form units are on the X axis, set this parameter to FALSE. If the form units are on the Y axis, set this parameter to TRUE. |
Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.
Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.
Sends a message to all child items of a form window, dialog box, table window, or MDI window.
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
Sets a window's cursor.
Parameter | Type | Description |
|---|---|---|
typeResource | | |
type | |
Sets a window's cursor.
Sets a window's cursor from a string variable.
Sets an application-defined cursor for the specified window. Use this function to set the cursor from an image stored in a file.
Sets the focus to a specified window.
Sets a window's font, font size, and font enhancements.
Moves a window to a new position (x, y) on the X and Y axes.
Sets the value of a named property.
Resizes a window.
Displays specified text in the status bar of a top-level or MDI window.
Parameter | Type | Description |
|---|---|---|
sText | |
Sets the text of a window.
Parameter | Type | Description |
|---|---|---|
text | |
Creates a system timer for a given object. When a timer event occurs, sends SAM_Timer messages to the object in specified intervals. Timers are a limited global resource. Your application must check the value returned by SalTimerSet to verify that the timer was created.
Sets a window's color.
Parameter | Type | Description |
|---|---|---|
colorIndex |