SalRibbonBarBase
PPJ.Runtime.Windows.SalRibbonBarBase
Last updated
PPJ.Runtime.Windows.SalRibbonBarBase
Last updated
Namespace: PPJ.Runtime.Windows
Assembly: PPJ.Runtime.49 (4.9.0.0)
Base class for all RibbonBar forms.
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.
CultureInfo: Returns/Sets the culture to use for this form.
String: Icon name. The image is loaded from the embedded resources.
SalNamedProperties: Returns the collection of named properties.
Freezes screen updates to the form.
Brings a window to the top of all overlapping windows.
Returns: SalBoolean.
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.
Returns: SalBoolean.
Clears a window's cursor.
| Parameter | Type | Description |
|---|---|---|
type |
Returns: SalBoolean.
Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.
Returns: SalBoolean.
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.
Returns: SalBoolean.
Redraws the menu bar for a given form window or top-level table window.
Returns: SalBoolean.
Enables keyboard and mouse input to a window.
Returns: SalBoolean.
Destroys a modal dialog box and returns control to the caller of SalModalDialog.
| Parameter | Type | Description |
|---|---|---|
nReturn |
Returns: SalBoolean.
Enables screen updates to the form.
This function finds a child window of a given name in the specified window.
| Parameter | Type | Description |
|---|---|---|
windowName |
Returns: SalWindowHandle.
Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.
Returns: SalNumber.
Dispatches the specified message (Window Actions) directly to the children's WindowActions event handlers, without going through Windows message loop.
Returns: SalBoolean.
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. |
Returns: SalNumber.
Return the name of a window's class as a string.
Returns: SalString.
Returns an object's type.
Returns: SalNumber.
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: SalWindowHandle.
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. |
Returns: SalWindowHandle.
| Parameter | Type | Description |
|---|---|---|
name | ||
size | ||
enhancement |
Returns: SalBoolean.
| Parameter | Type | Description |
|---|---|---|
x | ||
y |
Returns: SalBoolean.
| Parameter | Type | Description |
|---|---|---|
text |
Returns: SalBoolean.
Gets the name of an object.
Returns: SalString.
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: SalWindowHandle.
Returns the handle of an object's parent window.
Returns: SalWindowHandle.
| Parameter | Type | Description |
|---|---|---|
name | ||
value |
Returns: SalBoolean.
Gets the value of a named property.
| Parameter | Type | Description |
|---|---|---|
name |
Returns: SalString.
| Parameter | Type | Description |
|---|---|---|
width | ||
height |
Returns: SalBoolean.
| Parameter | Type | Description |
|---|---|---|
sText | ||
nMaxLen |
Returns: SalNumber.
Gets the text displayed in the status bar of a top-level or MDI window.
| Parameter | Type | Description |
|---|---|---|
nMaxLen |
Returns: SalString.
| Parameter | Type | Description |
|---|---|---|
text | ||
maxLen |
Returns: SalNumber.
Retrieves the text of a window.
| Parameter | Type | Description |
|---|---|---|
maxLen |
Returns: SalString.
Gets a window's color.
| Parameter | Type | Description |
|---|---|---|
colorIndex |
Returns: SalNumber.
Returns a window's current state.
Returns: SalNumber.
Hides a window.
Returns: SalBoolean.
Causes a window to be repainted.
Returns: SalBoolean.
Determines whether a window is an instance of the specified class.
| Parameter | Type | Description |
|---|---|---|
typeClass |
Returns: SalBoolean.
Determines whether a window is enabled for mouse and keyboard input.
Returns: SalBoolean.
Determines whether a window is currently visible.
Returns: SalBoolean.
Destroys an object's system timer.
| Parameter | Type | Description |
|---|---|---|
idEvent |
Returns: SalBoolean.
Moves a window a given number of form units on the X and Y axes relative to its current position.
Returns: SalBoolean.
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. |
Returns: SalNumber.
Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.
Returns: SalBoolean.
Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.
Returns: SalNumber.
Sends a message to all child items of a form window, dialog box, table window, or MDI window.
Returns: SalBoolean.
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
Returns: SalBoolean.
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
Returns: SalBoolean.
Sets a window's cursor.
| Parameter | Type | Description |
|---|---|---|
typeResource | ||
type |
Returns: SalBoolean.
Sets a window's cursor.
Returns: SalBoolean.
Sets a window's cursor from a string variable.
Returns: SalBoolean.
Sets an application-defined cursor for the specified window. Use this function to set the cursor from an image stored in a file.
Returns: SalBoolean.
Sets the focus to a specified window.
Returns: SalWindowHandle.
Sets a window's font, font size, and font enhancements.
Returns: SalBoolean.
Moves a window to a new position (x, y) on the X and Y axes.
Returns: SalBoolean.
Sets the value of a named property.
Returns: SalBoolean.
Resizes a window.
Returns: SalBoolean.
Displays specified text in the status bar of a top-level or MDI window.
| Parameter | Type | Description |
|---|---|---|
sText |
Returns: SalBoolean.
Sets the text of a window.
| Parameter | Type | Description |
|---|---|---|
text |
Returns: SalBoolean.
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.
Returns: SalBoolean.
Sets a window's color.
Returns: SalBoolean.
Shows the form.
| Parameter | Type | Description |
|---|---|---|
parent |
Shows the modal dialog.
| Parameter | Type | Description |
|---|---|---|
parent |
Returns: Int32.
Shows or hides the status bar on a top-level or MDI window.
| Parameter | Type | Description |
|---|---|---|
bShow |
Returns: SalBoolean.
Shows or hides the tool bar on a top-level or MDI window.
| Parameter | Type | Description |
|---|---|---|
bShow |
Returns: SalBoolean.
Makes a window visible.
Returns: SalBoolean.
Creates pop-up menus at runtime.
Returns: SalBoolean.
Creates pop-up menus at runtime.
Returns: SalBoolean.
Forces the update of a window.
Returns: SalBoolean.
Starts the Windows help system.
Returns: SalBoolean.
Processes messages for this control.
SalMessageHandler Message Actions
PaintEventHandler fired when the form needs to paint the background, this event is missing from WinForms.
WindowActionsEventHandler Window Actions
| Name | Description |
|---|---|
Top level MDI form with ribbon. | |
Top level form with ribbon. |
| Name | Description |
|---|---|
All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface. |
