XSalSplitter

Namespace: PPJ.Runtime.XSal

Assembly: PPJ.Web.XSal.49 (4.9.0.0)

• Control
  • ScrollableControl
    • ContainerControl
      • SplitContainer
        • XSalSplitter

C#

public class XSalSplitter : SplitContainer, ISalWindow, ISalAccessory

VB.NET

Public Class XSalSplitter
    Inherits SplitContainer
    Implements ISalWindow, ISalAccessory

Properties

FirstControl

Control: Returns/Sets the control bound to the first split panel.

InvertDocking

Boolean: Determines which panel is fixed when the splitter is not proportional. (Default: False)

MinExtra

Int32: Sets or returns the minimum size of the second panel. That is the extra space at the right/bottom of the splitter. (Default: 0)

MinSize

Int32: Sets or returns the minimum size of the first split panel. (Default: 0)

NamedProperties

SalNamedProperties: Returns the collection of named properties.

Position

Int32: Returns/Sets the position of the splitter.

Proportional

Boolean: Returns/Sets whether the splitter position is proportional. (Default: True)

SecondControl

Control: Returns/Sets the control bound to the first split panel.

Text

String: Sets or returns the Text of the splitter control. The text string contains two labels separated by ";", one for each split panel. (Default: "")

Methods

BringWindowToTop()

Brings a window to the top of all overlapping windows.

Returns: SalBoolean.

CenterWindow()

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.

ClearCursor(nType)

Clears a window's cursor.

Parameter	Type	Description
nType	SalNumber

Returns: SalBoolean.

DestroyWindow()

Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.

Returns: SalBoolean.

DisableWindow()

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.

EnableWindow()

Enables keyboard and mouse input to a window.

Returns: SalBoolean.

FindChild(sWindowName)

This function finds a child window of a given name in the specified window.

Parameter	Type	Description
sWindowName	SalString

Returns: SalWindowHandle.

FormUnitsToPixels(nFormUnits, bVertical)

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
nFormUnits	SalNumber
bVertical	SalBoolean

Returns: SalNumber.

FromHandle(handle)

Returns the control associated with the handle.

Parameter	Type	Description
handle	SalWindowHandle

Returns: XSalSplitter.

GetBarPosition()

Returns the position of the splitter.

Returns: SalNumber.

GetClassName()

Return the name of a window's class as a string.

Returns: SalString.

GetControlType()

Returns an object's type.

Returns: SalNumber.

GetFirstChild(nTypeMask)

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
nTypeMask	SalNumber

Returns: SalWindowHandle.

GetFont(sName, nSize, nEnhancement)

Parameter	Type	Description
sName	SalString&
nSize	SalNumber&
nEnhancement	SalNumber&

Returns: SalBoolean.

GetLocation(nX, nY)

Parameter	Type	Description
nX	SalNumber&
nY	SalNumber&

Returns: SalBoolean.

GetName(sText)

Parameter	Type	Description
sText	SalString&

Returns: SalBoolean.

GetName()

Gets the name of an object.

Returns: SalString.

GetNextChild(nTypeMask)

Returns the handle of the next child window that matches a specified type.

Parameter	Type	Description
nTypeMask	SalNumber

Returns: SalWindowHandle.

GetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

GetProperty(sName, sValue)

Parameter	Type	Description
sName	SalString
sValue	SalString&

Returns: SalBoolean.

GetProperty(sName)

Gets the value of a named property.

Parameter	Type	Description
sName	SalString

Returns: SalString.

GetSize(nWidth, nHeight)

Parameter	Type	Description
nWidth	SalNumber&
nHeight	SalNumber&

Returns: SalBoolean.

GetStyle()

Returns: SplitterStyles.

GetText(sText, nMaxLen)

Parameter	Type	Description
sText	SalString&
nMaxLen	SalNumber

Returns: SalNumber.

GetText(nMaxLen)

Retrieves the text of a window.

Parameter	Type	Description
nMaxLen	SalNumber

Returns: SalString.

GetWindowColor(nColorIndex)

Gets a window's color.

Parameter	Type	Description
nColorIndex	SalNumber

Returns: SalNumber.

GetWindowState()

Returns a window's current state.

Returns: SalNumber.

HideWindow()

Hides a window.

Returns: SalBoolean.

InvalidateWindow()

Causes a window to be repainted.

Returns: SalBoolean.

IsDerivedFromClass(tClass)

Determines whether a window is an instance of the specified class.

Parameter	Type	Description
tClass	Type

Returns: SalBoolean.

IsEnabled()

Determines whether a window is enabled for mouse and keyboard input.

Returns: SalBoolean.

IsVisible()

Determines whether a window is currently visible.

Returns: SalBoolean.

KillTimer(nIDEvent)

Destroys an object's system timer.

Parameter	Type	Description
nIDEvent	SalNumber

Returns: SalBoolean.

MoveWindow(nXOffset, nYOffset)

Moves a window a given number of form units on the X and Y axes relative to its current position.

Parameter	Type	Description
nXOffset	SalNumber
nYOffset	SalNumber

Returns: SalBoolean.

PixelsToFormUnits(nNumPixels, bVertical)

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
nNumPixels	SalNumber
bVertical	SalBoolean

Returns: SalNumber.

PostMessage(nMsg, nMywParam, nMylParam)

Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.

Parameter	Type	Description
nMsg	SalNumber
nMywParam	SalNumber
nMylParam	SalNumber

Returns: SalBoolean.

SendMessage(nMsg, nMywParam, nMylParam)

Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.

Parameter	Type	Description
nMsg	SalNumber
nMywParam	SalNumber
nMylParam	SalNumber

Returns: SalNumber.

SendMessageToChildren(nMsg, nMywParam, nMylParam)

Sends a message to all child items of a form window, dialog box, table window, or MDI window.

Parameter	Type	Description
nMsg	SalNumber
nMywParam	SalNumber
nMylParam	SalNumber

Returns: SalBoolean.

SetBarPosition(nPos)

Sets the position of the splitter.

Parameter	Type	Description
nPos	SalNumber

Returns: SalBoolean.

SetBarSize(nSize)

Sets the size of the splitter.

Parameter	Type	Description
nSize	SalNumber

Returns: SalBoolean.

SetContextMenu(sMenuName, nFlags)

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

Parameter	Type	Description
sMenuName	SalString
nFlags	SalNumber

Returns: SalBoolean.

SetContextMenu(menuType, nFlags)

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

Parameter	Type	Description
menuType	Type
nFlags	SalNumber

Returns: SalBoolean.

SetCursor(nResourceId, nType)

Sets a window's cursor.

Parameter	Type	Description
nResourceId	Int32
nType	SalNumber

Returns: SalBoolean.

SetCursor(sBlob, nType)

Sets a window's cursor from a string variable.

Parameter	Type	Description
sBlob	SalString
nType	SalNumber

Returns: SalBoolean.

SetCursorFile(sFile, nType)

Sets an application-defined cursor for the specified window. Use this function to set the cursor from an image stored in a file.

Parameter	Type	Description
sFile	SalString
nType	SalNumber

Returns: SalBoolean.

SetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandle.

SetFont(sName, nSize, nEnhancement)

Sets a window's font, font size, and font enhancements.

Parameter	Type	Description
sName	SalString
nSize	SalNumber
nEnhancement	SalNumber

Returns: SalBoolean.

SetLocation(nX, nY)

Moves a window to a new position (x, y) on the X and Y axes.

Parameter	Type	Description
nX	SalNumber
nY	SalNumber

Returns: SalBoolean.

SetMinMaxPosition(nMin, nMax)

Sets the minimum and maximum positions for the splitter.

Parameter	Type	Description
nMin	SalNumber
nMax	SalNumber

Returns: SalBoolean.

SetProperty(sName, sValue, nLength)

Sets the value of a named property.

Parameter	Type	Description
sName	SalString
sValue	SalString
nLength	SalNumber

Returns: SalBoolean.

SetSize(nWidth, nHeight)

Resizes a window.

Parameter	Type	Description
nWidth	SalNumber
nHeight	SalNumber

Returns: SalBoolean.

SetStyle(Style, bOn)

Sets the style of the splitter.

Parameter	Type	Description
Style	SplitterStyles
bOn	SalBoolean

Returns: SalBoolean.

SetText(sText)

Sets the text of a window.

Parameter	Type	Description
sText	SalString

Returns: SalBoolean.

SetTimer(nIDEvent, nElapseMilliSec)

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.

Parameter	Type	Description
nIDEvent	SalNumber
nElapseMilliSec	SalNumber

Returns: SalBoolean.

SetWindowColor(nColorIndex, nColor)

Sets a window's color.

Parameter	Type	Description
nColorIndex	SalNumber
nColor	SalNumber

Returns: SalBoolean.

ShowWindow()

Makes a window visible.

Returns: SalBoolean.

TrackPopupMenu(sMenuName, nFlags, nX, nY)

Creates pop-up menus at runtime.

Parameter	Type	Description
sMenuName	SalString
nFlags	SalNumber
nX	SalNumber
nY	SalNumber

Returns: SalBoolean.

TrackPopupMenu(menuType, nFlags, nX, nY)

Creates pop-up menus at runtime.

Parameter	Type	Description
menuType	Type
nFlags	SalNumber
nX	SalNumber
nY	SalNumber

Returns: SalBoolean.

UpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

Events

WindowActions

WindowActionsEventHandler

Inherited By

Name	Description
XSalHSplitter
XSalVSplitter

Implements

Name	Description
ISalAccessory
ISalWindow