VisCalendar
Namespace: PPJ.Runtime.Vis
Assembly: PPJ.Web.Vis.50 (5.0.0.0)
A SAL month calendar supporting date ranges, recurring bold dates, and Visual Toolchest notifications.
- C#
- VB.NET
public class VisCalendar : MonthCalendar, ISalWindow, ISalEditControl, ISalControl
Public Class VisCalendar
Inherits MonthCalendar
Implements ISalWindow, ISalEditControl, ISalControl
Example:
var calendar = new VisCalendar();
calendar.SetFocusDate(System.DateTime.Today);
var dates = new SalArray<SalDateTime>();
calendar.GetSelectedDates(ref dates);
Constructors
VisCalendar()
Initializes SAL window state, remembers the current selection, and hides the today indicator.
Properties
Label
Control: Gets or sets the label associated with this control through its containing SAL form.
NamedProperties
SalNamedProperties: Gets this window's SAL named-property collection.
Text
String: Gets or sets the calendar text while suppressing invalid-format exceptions. (Default: "")
Methods
BringWindowToTop()
Brings this control to the front, or activates it when it is a top-level or MDI form.
Returns: SalBoolean. True if the translated control exists and is not disposed; otherwise, false.
CenterWindow()
Centers this window within its parent, owner, or available screen area.
Returns: SalBoolean. True if the centering operation is accepted; false for an unavailable control, design mode, or unavailable screen bounds.
ClearCursor(nType)
Restores the default cursor for the requested role.
| Parameter | Type | Description |
|---|---|---|
| nType | SalNumber | The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
Only the window role changes the displayed cursor. Drag/drop roles are accepted for SAL windows without changing a cursor.
ClearSpecialDates()
Removes all bold-date rules and updates the control.
Returns: SalBoolean. Always true.
DestroyWindow()
Closes this window when it is a form, or disposes the control.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
A true result reports that the close or disposal request was made; a form can apply its own closing behavior.
DisableWindow()
Disables input to this control, or clears editability for a table column.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
DisableWindowAndLabel()
Disables input to this control and disables its associated label.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
Dispose(disposing)
Marks this SAL window disposed before releasing the base control resources.
| Parameter | Type | Description |
|---|---|---|
| disposing | Boolean | True to release managed resources; false for finalization cleanup. |
EnableWindow()
Enables input to this control, or enables editing for a table column.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
For text-box controls, this operation also clears the read-only setting.
EnableWindowAndLabel()
Enables input to this control and enables its associated label.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
FindChild(sWindowName)
Searches this window for a child control by name.
| Parameter | Type | Description |
|---|---|---|
| sWindowName | SalString | The child control name to locate. |
Returns: SalWindowHandle. The matching child handle, or a null SAL handle if no child is found.
FormUnitsToPixels(nFormUnits, bVertical)
Converts a length in form units to pixels using this control's form metrics.
| Parameter | Type | Description |
|---|---|---|
| nFormUnits | SalNumber | The length in form units. |
| bVertical | SalBoolean | True for a vertical measurement; false for a horizontal measurement. |
Returns: SalNumber. The converted pixel length.
FromHandle(hWnd)
Resolves a SAL handle to an existing VisCalendar.
| Parameter | Type | Description |
|---|---|---|
| hWnd | SalWindowHandle | The control handle to resolve. |
Returns: VisCalendar. The associated control, or when no control is resolved.
Throws:
- InvalidCastException The handle identifies an incompatible control type.
GetClassName()
Gets the application class name associated with this control.
Returns: SalString. The application class name, an empty string for runtime-defined classes, or a SAL null string when the control cannot be resolved.
Forms are represented by their base type; nested table-window types are resolved to their non-nested base.
GetColor(nColorRole)
Reads a supported calendar color role.
| Parameter | Type | Description |
|---|---|---|
| nColorRole | SalNumber | COLOR_CAL_BackExtra for the background or COLOR_CAL_ForeDays for the foreground. |
Returns: SalNumber. The Win32 color value. Other roles return the conversion of Color.Empty.
GetControlType()
Gets the SAL window type of this control.
Returns: SalNumber. The SAL Sys.TYPE_* code for the translated control.
GetDataType()
Gets the SAL data type represented by this control.
Returns: SalNumber. The SAL data-type code, or zero if the translated control does not implement the SAL value contract.
GetFirstChild(nTypeMask)
Finds the first child matching a SAL window-type mask.
| Parameter | Type | Description |
|---|---|---|
| nTypeMask | SalNumber | The SAL window types to include; zero matches no controls. |
Returns: SalWindowHandle. The first matching child handle, or a null SAL handle when none matches.
Ordinary controls use tab order; table columns use their creation order, and MDI forms use their child-form collection.
GetFocusDate(lpdtDateTime)
Copies the current selection start to the caller.
| Parameter | Type | Description |
|---|---|---|
| lpdtDateTime | SalDateTime | Receives the selection start. |
Returns: SalBoolean. Always true.
GetFont(sName, nSize, nEnhancement)
Reads the control font's family, point size, and style flags.
| Parameter | Type | Description |
|---|---|---|
| sName | SalString | Receives the font family name. |
| nSize | SalNumber | Receives the size in points. |
| nEnhancement | SalNumber | Receives the combined Sys.FONT_Enh* style flags. |
Returns: SalBoolean. True if a font was available; otherwise, false.
GetLabel()
Gets the label associated with this control.
Returns: SalWindowHandle. The associated label handle, or a null SAL handle if no label can be found.
GetLabelText(sText, nMaxLength)
Copies the associated label text to a supplied variable.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | Receives the label text when it can be read. |
| nMaxLength | SalNumber | The maximum number of leading characters to copy. |
Returns: SalNumber. The number of characters copied, or zero if no label text is available.
GetLabelText(nMaxLength)
Gets this control's associated label text.
| Parameter | Type | Description |
|---|---|---|
| nMaxLength | SalNumber | The maximum number of leading characters to return. |
Returns: SalString. The label text limited to the requested length, or an empty string if no label exists.
GetLocation(nX, nY)
Reads this control's location in form units.
| Parameter | Type | Description |
|---|---|---|
| nX | SalNumber | Receives the horizontal location. |
| nY | SalNumber | Receives the vertical location. |
Returns: SalBoolean. Always true; an unresolved control produces zero coordinates.
GetName(sText)
Copies this control's name to the supplied variable.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | Receives the control name when the operation succeeds. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
GetName()
Gets this control's name.
Returns: SalString. The control name, or an empty string if the control cannot be resolved.
GetNextChild(nTypeMask)
Finds the next sibling matching a SAL window-type mask.
| Parameter | Type | Description |
|---|---|---|
| nTypeMask | SalNumber | The SAL window types to include; zero matches no controls. |
Returns: SalWindowHandle. The next matching control handle, or a null SAL handle when none matches.
GetParent()
Gets the SAL parent form, owner, or table container for this control.
Returns: SalWindowHandle. The parent window handle, or a null SAL handle if no parent can be resolved.
GetProperty(sName, sValue)
Reads a SAL named property into a supplied variable.
| Parameter | Type | Description |
|---|---|---|
| sName | SalString | The property name. |
| sValue | SalString | Receives the value only when the property is found. |
Returns: SalBoolean. True if a non-null property value was found; otherwise, false.
GetProperty(sName)
Gets the value of a SAL named property.
| Parameter | Type | Description |
|---|---|---|
| sName | SalString | The property name. |
Returns: SalString. The property value, or a SAL null string if the value is unavailable.
GetSelectedDates(dtDates)
Writes the selected date or range endpoints to an existing array.
| Parameter | Type | Description |
|---|---|---|
| dtDates | SalArray<SalDateTime> | A non-null array resized to indices 0..0 for one date or 0..1 for a range. |
Returns: SalNumber. One for a single date, or two for the start and end of a range.
Intermediate dates are not enumerated.
GetSize(nWidth, nHeight)
Reads this control's size in form units.
| Parameter | Type | Description |
|---|---|---|
| nWidth | SalNumber | Receives the width. |
| nHeight | SalNumber | Receives the height. |
Returns: SalBoolean. Always true; an unresolved control produces a zero size.
GetText(sText, nMaxLen)
Copies this control's displayed text or long-string value to a SAL string.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | Receives the retrieved text. |
| nMaxLen | SalNumber | The maximum character count for ordinary text; ignored for a Sys.DT_LongString value. |
Returns: SalNumber. The number of characters copied, or zero when no text is available.
GetText(nMaxLen)
Gets this control's displayed text or long-string value.
| Parameter | Type | Description |
|---|---|---|
| nMaxLen | SalNumber | The maximum character count for ordinary text; ignored for a Sys.DT_LongString value. |
Returns: SalString. The retrieved text, or an empty string if the control cannot be resolved.
GetWeekStart()
Converts the configured first day to the legacy day numbering.
Returns: SalNumber. One for the default setting; otherwise the underlying day value plus two, reduced by seven when the result exceeds six.
The implemented conversion yields zero for Saturday.
GetWindowColor(nColorIndex)
Reads a window or cell color as a Win32 color value.
| Parameter | Type | Description |
|---|---|---|
| nColorIndex | SalNumber | The Sys.COLOR_Index* color component to read. |
Returns: SalNumber. The color encoded as a Win32 color value, or zero if the control is unavailable.
GetWindowState()
Gets the visibility and form-state classification of this window.
Returns: SalNumber. A Sys.Window_* state code; visible non-form controls report Sys.Window_Normal.
HideWindow()
Hides this control or table column.
Returns: SalBoolean. The visibility state before the operation, or false if the control cannot be resolved.
HideWindowAndLabel()
Hides this control and its associated label.
Returns: SalBoolean. The control's visibility before the operation, or false if it cannot be resolved.
InvalidateWindow()
Invalidates this control and its child controls for repainting.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
IsDerivedFromClass(tClass)
Tests this control's runtime type against an application base type.
| Parameter | Type | Description |
|---|---|---|
| tClass | Type | The type to test, including the framework's emulated inheritance relationships. |
Returns: SalBoolean. True if the runtime type derives from the requested type; otherwise, false.
IsEnabled()
Determines whether this control accepts input.
Returns: SalBoolean. The enabled state, or the editable flag for a table column; false if the control cannot be resolved.
IsModified()
Reads this control's SAL modification flag.
Returns: SalBoolean. True if the control reports a modified value; otherwise, false.
IsSelectedDate(dtDate)
Tests whether a date lies within the inclusive selected range.
| Parameter | Type | Description |
|---|---|---|
| dtDate | SalDateTime | The date to test. |
Returns: SalBoolean. True when the date is between SelectionStart and SelectionEnd.
IsSpecialDate(nRuleType, dtSearch, nWeekDay, nSequence, nForegroundColor, nBackgroundColor)
Tests whether the corresponding bold-date rule exists.
| Parameter | Type | Description |
|---|---|---|
| nRuleType | SalNumber | The SPECIAL_* rule identifying a one-time or recurring date. |
| dtSearch | SalDateTime | The reference date required by date-based rules. |
| nWeekDay | SalNumber | The DAY_* weekday for weekday-based rules. |
| nSequence | SalNumber | The occurrence within the month used by weekday rules. |
| nForegroundColor | SalNumber | Retained for compatibility; ignored. |
| nBackgroundColor | SalNumber | Retained for compatibility; ignored. |
Returns: SalBoolean. True if a matching rule exists; false for unset or incomplete rules.
IsVisible()
Determines whether this control is visible.
Returns: SalBoolean. The visible state, or the visibility flag for a table column; false if the control cannot be resolved.
KillTimer(nIDEvent)
Stops an existing timer owned by this control.
| Parameter | Type | Description |
|---|---|---|
| nIDEvent | SalNumber | The identifier used when the timer was started. |
Returns: SalBoolean. True if the timer was found and stopped; otherwise, false.
The timer remains registered and can be restarted by SetTimer.
MoveWindow(nXOffset, nYOffset)
Moves this control by an offset expressed in form units.
| Parameter | Type | Description |
|---|---|---|
| nXOffset | SalNumber | The horizontal offset to add to the current position. |
| nYOffset | SalNumber | The vertical offset to add to the current position. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
OnClick(e)
Raises the inherited event, then dispatches SAM_Click to the SAL message handlers.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data. |
OnDateChanged(drevent)
Updates SAL modification state and issues a calendar notification after the inherited event.
| Parameter | Type | Description |
|---|---|---|
| drevent | DateRangeEventArgs | The selected-range event data. |
A changed month posts CALN_Scroll; another changed selection start sends CALN_DateChanged synchronously.
OnDoubleClick(e)
Raises the inherited event, then dispatches SAM_DoubleClick to the SAL message handlers.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data. |
OnDragDrop(e)
Processes the SAL drop notification before raising the inherited event.
| Parameter | Type | Description |
|---|---|---|
| e | DragEventArgs | The event data passed to both handlers. |
OnDragEnd(e)
Ends SAL drag handling before raising the inherited drag-end event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data passed to both handlers. |
OnDragEnter(e)
Processes the SAL drag-enter notification before raising the inherited event.
| Parameter | Type | Description |
|---|---|---|
| e | DragEventArgs | The event data passed to both handlers. |
OnDragLeave(e)
Processes the SAL drag-leave notification before raising the inherited event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data passed to both handlers. |
OnDragOver(e)
Processes SAL drag feedback before raising the inherited drag-over event.
| Parameter | Type | Description |
|---|---|---|
| e | DragEventArgs | The event data passed to both handlers. |
OnDragStart(e)
Starts SAL drag handling before raising the inherited drag-start event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data passed to both handlers. |
OnGotFocus(e)
Dispatches SAL focus-gained processing before raising the inherited focus event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The focus event data. |
OnLostFocus(e)
Dispatches SAL focus-lost processing before raising the inherited focus event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The focus event data. |
OnValidating(e)
Runs SAL validation before raising the inherited validation event.
| Parameter | Type | Description |
|---|---|---|
| e | CancelEventArgs | The event data passed to both handlers. |
OnWebEvent(e)
Processes the browser event in a root SAL context, then dispatches its simulated WinSDK event.
| Parameter | Type | Description |
|---|---|---|
| e | WisejEventArgs | The browser event to process. |
OnWebRender(config)
Adds the calendar client class and bold-date data to the browser configuration.
| Parameter | Type | Description |
|---|---|---|
| config | Object | The mutable browser configuration. |
PixelsToFormUnits(nNumPixels, bVertical)
Converts a pixel length to form units using this control's form metrics.
| Parameter | Type | Description |
|---|---|---|
| nNumPixels | SalNumber | The pixel length to convert. |
| bVertical | SalBoolean | True for a vertical measurement; false for a horizontal measurement. |
Returns: SalNumber. The converted length in form units.
PostMessage(nMsg, nMywParam, nMylParam)
Queues a SAL window action for later dispatch on the application context.
| Parameter | Type | Description |
|---|---|---|
| nMsg | SalNumber | The SAL or application-defined message code. |
| nMywParam | SalNumber | The first message parameter. |
| nMylParam | SalNumber | The second message parameter. |
Returns: SalBoolean. True if the action was queued; false if the control is unavailable or disposed.
RemoveAllBoldedDates()
Clears the stored bold-date rules and requests a control update.
SelectDate(dtDate, fSelect)
Sets the selection start and clears the modified flag.
| Parameter | Type | Description |
|---|---|---|
| dtDate | SalDateTime | The requested selection start. |
| fSelect | SalBoolean | True to use dtDate; false to use the current date and time. |
Returns: SalBoolean. Always true if the date assignment succeeds.
SelectDates(dtDates, fSelect)
Sets a selected range from a two-element array.
| Parameter | Type | Description |
|---|---|---|
| dtDates | SalArray<SalDateTime> | An array containing the start at index zero and end at index one. |
| fSelect | SalBoolean | Retained for compatibility; ignored. |
Returns: SalNumber. Two after assigning the range, or zero when the array length is not two.
Clears the modified flag after assignment.
SendMessage(nMsg, nMywParam, nMylParam)
Dispatches a SAL window action synchronously and returns its result.
| Parameter | Type | Description |
|---|---|---|
| nMsg | SalNumber | The SAL or application-defined message code. |
| nMywParam | SalNumber | The first message parameter. |
| nMylParam | SalNumber | The second message parameter. |
Returns: SalNumber. The action's return value, or zero if the target is unavailable or disposed.
SendMessageToChildren(nMsg, nMywParam, nMylParam)
Dispatches a SAL message to this control's children.
| Parameter | Type | Description |
|---|---|---|
| nMsg | SalNumber | The SAL or application-defined message code. |
| nMywParam | SalNumber | The first message parameter. |
| nMylParam | SalNumber | The second message parameter. |
Returns: SalBoolean. The result of child-message dispatch; false if the parent is unavailable or disposed.
SetColor(nColorRole, nNewColor)
Changes a supported calendar color role.
| Parameter | Type | Description |
|---|---|---|
| nColorRole | SalNumber | COLOR_CAL_BackExtra for the background or COLOR_CAL_ForeDays for the foreground. |
| nNewColor | SalNumber | The SAL color to apply. |
Returns: SalNumber. The previous color returned by GetColor.
Other roles do not change the control.
SetContextMenu(sMenuName, nFlags)
Creates and assigns a context menu for this control.
| Parameter | Type | Description |
|---|---|---|
| sMenuName | SalString | The name used to resolve the menu type. |
| nFlags | SalNumber | Use Sys.CM_TableCell to target the associated table column; other values target the control. |
Returns: SalBoolean. True if the menu was created; false if the control or menu type is unavailable or menu creation fails.
SetContextMenu(menuType, nFlags)
Creates and assigns a context menu for this control.
| Parameter | Type | Description |
|---|---|---|
| menuType | Type | The type of the menu to create. |
| nFlags | SalNumber | Use Sys.CM_TableCell to target the associated table column; other values target the control. |
Returns: SalBoolean. True if the menu was created; false if the control or menu type is unavailable or menu creation fails.
SetCursor(nResourceId, nType)
Assigns a predefined cursor to the requested role.
| Parameter | Type | Description |
|---|---|---|
| nResourceId | Int32 | A supported Sys.CURSOR_* cursor identifier. |
| nType | SalNumber | The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
Only the window role changes the displayed cursor. Drag/drop roles are accepted for SAL windows without changing a cursor.
SetCursor(sBlob, nType)
Requests a cursor from binary data; this web implementation does not support binary cursor loading.
| Parameter | Type | Description |
|---|---|---|
| sBlob | SalString | The binary cursor data. |
| nType | SalNumber | The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop. |
Returns: SalBoolean. Always false.
SetCursorFile(sFile, nType)
Loads a cursor from a file and assigns it to the requested role.
| Parameter | Type | Description |
|---|---|---|
| sFile | SalString | The cursor file path. |
| nType | SalNumber | The cursor role: Sys.CURSOR_Window, Sys.CURSOR_DragDrop, or Sys.CURSOR_DisableDrop. |
Returns: SalBoolean. True if loading and assignment succeed; otherwise, false.
Only the window role changes the displayed cursor. Drag/drop roles are accepted for SAL windows without changing a cursor.
SetFocus()
Requests keyboard focus for this control.
Returns: SalWindowHandle. The previously focused control's handle, or a null SAL handle when no previous control exists or this target is ineligible.
Hidden or disabled controls and table columns are ineligible.
SetFocusDate(dtNewFocus)
Sets the focused date and clears the modified flag.
| Parameter | Type | Description |
|---|---|---|
| dtNewFocus | SalDateTime | The requested date, or SAL null to use the current date and time. |
Returns: SalBoolean. Always true if the date assignment succeeds.
SetFont(sName, nSize, nEnhancement)
Creates and assigns a font to this control.
| Parameter | Type | Description |
|---|---|---|
| sName | SalString | The font family name. |
| nSize | SalNumber | The font size in points. |
| nEnhancement | SalNumber | The combined Sys.FONT_Enh* style flags. |
Returns: SalBoolean. True if the font was created and assigned; otherwise, false.
SetLabelText(sText)
Assigns the text of this control's associated label.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | The label text to display. |
Returns: SalBoolean. True if an associated label was found and updated; otherwise, false.
SetLocation(nX, nY)
Sets this control's location in form units.
| Parameter | Type | Description |
|---|---|---|
| nX | SalNumber | The new horizontal coordinate. |
| nY | SalNumber | The new vertical coordinate. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
For forms, this also selects manual startup positioning.
SetModified(bSet)
Sets this control's SAL modification flag.
| Parameter | Type | Description |
|---|---|---|
| bSet | SalBoolean | True to mark the value modified; false to clear the flag. |
Returns: SalBoolean. True if the translated control supports SAL values; otherwise, false.
For editable SAL controls, this also clears the validation flag.
SetProperty(sName, sValue, nLength)
Assigns a SAL named property after limiting the value's length.
| Parameter | Type | Description |
|---|---|---|
| sName | SalString | The property name. |
| sValue | SalString | The value to assign. |
| nLength | SalNumber | The number of leading characters to retain. |
Returns: SalBoolean. True if the translated control implements the SAL window contract; otherwise, false.
SetSize(nWidth, nHeight)
Sets this control's dimensions in form units.
| Parameter | Type | Description |
|---|---|---|
| nWidth | SalNumber | The new width. |
| nHeight | SalNumber | The new height. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
SetSpecialDate(nRuleType, dtSearch, nWeekDay, nSequence, nForegroundColor, nBackgroundColor, fSelect)
Adds or removes a bold-date rule.
| Parameter | Type | Description |
|---|---|---|
| nRuleType | SalNumber | The SPECIAL_* rule identifying a one-time or recurring date. |
| dtSearch | SalDateTime | The reference date required by date-based rules. |
| nWeekDay | SalNumber | The DAY_* weekday for weekday-based rules. |
| nSequence | SalNumber | The occurrence within the month used by weekday rules. |
| nForegroundColor | SalNumber | Retained for compatibility; ignored. |
| nBackgroundColor | SalNumber | Retained for compatibility; ignored. |
| fSelect | SalBoolean | True to add the rule; false to remove it. |
Returns: SalBoolean. Always true. Unset rules and rules missing their required date or weekday are ignored.
SetText(sText)
Assigns the control's text.
| Parameter | Type | Description |
|---|---|---|
| sText | SalString | The text to display. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
SetTimer(nIDEvent, nElapseMilliSec)
Starts or restarts a timer that sends SAL timer actions to this control.
| Parameter | Type | Description |
|---|---|---|
| nIDEvent | SalNumber | The timer identifier sent in the first parameter of each Sys.SAM_Timer action. |
| nElapseMilliSec | SalNumber | The interval between ticks, in milliseconds. |
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
SetWeekStart(nWeekday)
Sets the first day displayed in each calendar week.
| Parameter | Type | Description |
|---|---|---|
| nWeekday | SalNumber | The legacy day number, with Sunday represented by 1 and Monday by 2. |
Returns: SalBoolean. Always true if the underlying FirstDayOfWeek assignment succeeds.
SetWindowColor(nColorIndex, nColor)
Assigns a window or table-cell color.
| Parameter | Type | Description |
|---|---|---|
| nColorIndex | SalNumber | The Sys.COLOR_Index* component to change. |
| nColor | SalNumber | The SAL color value to translate and assign. |
Returns: SalBoolean. True for a supported color index and resolved control; otherwise, false.
Cell colors apply only to table columns. Window colors on table windows also update their grid styles.
ShowWindow()
Shows this control or table column.
Returns: SalBoolean. The visibility state before the operation, or false if the control cannot be resolved.
ShowWindowAndLabel()
Shows this control and its associated label.
Returns: SalBoolean. The control's visibility before the operation, or false if it cannot be resolved.
TrackPopupMenu(sMenuName, nFlags, nX, nY, callback)
Creates and displays a popup menu, disposing it after it closes.
| Parameter | Type | Description |
|---|---|---|
| sMenuName | SalString | The name used to resolve the menu type. |
| nFlags | SalNumber | Popup flags controlling right alignment and use of the current cursor coordinates. Center alignment and context-menu flags are not supported. |
| nX | SalNumber | The horizontal screen coordinate in pixels, unless the cursor-X flag is set. |
| nY | SalNumber | The vertical screen coordinate in pixels, unless the cursor-Y flag is set. |
| callback | Action<ContextMenu> | An optional callback invoked when the menu closes, before it is disposed. |
Returns: SalBoolean. True if the menu was created and shown; otherwise, false.
TrackPopupMenu(menuType, nFlags, nX, nY, callback)
Creates and displays a popup menu, disposing it after it closes.
| Parameter | Type | Description |
|---|---|---|
| menuType | Type | The menu type to instantiate. |
| nFlags | SalNumber | Popup flags controlling right alignment and use of the current cursor coordinates. Center alignment and context-menu flags are not supported. |
| nX | SalNumber | The horizontal screen coordinate in pixels, unless the cursor-X flag is set. |
| nY | SalNumber | The vertical screen coordinate in pixels, unless the cursor-Y flag is set. |
| callback | Action<ContextMenu> | An optional callback invoked when the menu closes, before it is disposed. |
Returns: SalBoolean. True if the menu was created and shown; otherwise, false.
UpdateWindow()
Requests an update of this control.
Returns: SalBoolean. True if the operation is accepted by the SAL window implementation; otherwise, false.
Events
WindowActions
WindowActionsEventHandler Occurs when the control receives a SAL or application-defined window action.
Implements
| Name | Description |
|---|---|
| ISalControl | |
| ISalEditControl | |
| ISalWindow |