SalTreeControl

PPJ.Runtime.Windows.SalTreeControl

Namespace: PPJ.Runtime.Windows

Assembly: PPJ.Runtime.49 (4.9.0.0)

TreeView implementation.

C#

public class SalTreeControl : TreeView, ISalWindow, ISalControl

VB.NET

Constructors

SalTreeControl()

Constructs a SalTreeControl object.

Properties

Label

Control: Returns/Sets the label associated with this control.

NamedProperties

SalNamedProperties: Returns the collection of named properties.

ShowRoot

Boolean: Shows the root node.

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.

Clear()

Clears the value from a data field, multi line field, or table window column.

Returns: SalBoolean.

ClearCursor(type)

Clears a window's cursor.

Parameter	Type	Description
type	SalNumber

Returns: SalBoolean.

CollapseItem(hItem)

Collapse a tree item. If the tree item handle is 0, then the top level tree items of the tree control are collapsed.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

DeleteItem(hItem)

Removes a tree item from a tree control. All child items of the tree item are also removed.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the item was deleted successfully.

DemoteItem(hItem)

Moves a tree item so it becomes the child of its previous sibling. This function will fail if the tree item has no previous sibling.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

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.

DisableWindowAndLabel()

Disables keyboard and mouse input to a window and grays out its associated label. A label is the label control that immediately precedes the window in the outline. The label control must have a mnemonic. 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.

EditItem(hItem)

Allows the user to edit the value of the tree item's label. SAM_Validate is sent to the tree control when the edit control loses focus with wParam indicating the handle to the tree item.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if edit has been activated.

EnableItem(hItem, bEnable)

Enables the tree item when bEnable is true, disables the tree item when bEnable is false.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
bEnable	SalBoolean	Set to TRUE to enable the item. Set to FALSE to disable the item.

Returns: SalBoolean. previous state of the item before this function was called. TRUE if it was enabled, FALSE if it was disabled.

EnableWindow()

Enables keyboard and mouse input to a window.

Returns: SalBoolean.

EnableWindowAndLabel()

Enables keyboard and mouse input to a window and enables its associated label as well. A label is the label control that immediately precedes the window in the outline.

Returns: SalBoolean.

ExpandItem(hItem)

Expand a tree item. If the tree item handle is 0, then the top level tree items of the tree control are expanded.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

FindChild(windowName)

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

Parameter	Type	Description
windowName	SalString

Returns: SalWindowHandle.

FindItemByData(hItem, nData)

Finds a tree item by its Object Data. Returns 0 if not found. Searches the child items of the tree item handle argument(hItem). If the handle is 0, searches the top level tree items.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
nData	SalNumber	Data of the item to find.

Returns: SalNumber. Handle of the tree item whose Data matches the nData parameter.

FindItemByTitle(hItem, sTitle)

Finds a tree item by its object title. Returns 0 if not found. Searches the child items of the tree item handle argument. If the handle is 0, searches the top level tree items.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
sTitle	SalString	Title of the item to find.

Returns: SalNumber. Handle of the item whose title matches the sTitle parameter.

FireWindowActions(msg, mywParam, mylParam)

Dispatches the specified message (Window Actions) directly to the control's WindowActions event handlers, without going through Windows message loop.

Parameter	Type	Description
msg	SalNumber
mywParam	SalNumber
mylParam	SalNumber

Returns: SalNumber.

FormUnitsToPixels(formUnits, vertical)

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	SalNumber	The number of form units.
vertical	SalBoolean	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.

GetClassName()

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

Returns: SalString.

GetControlType()

Returns an object's type.

Returns: SalNumber.

GetDataType()

Returns a data field's or table window column's data type.

Returns: SalNumber.

GetFirstChild(typeMask)

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	SalNumber	One or more window types combined (using the OR (|) operator) to create a mask of child window types.

Returns: SalWindowHandle.

GetFirstItem(hItem)

Gets the first child tree item of the passed tree item handle. Returns 0 if not found. If the handle is 0, returns the first child of the tree control.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalNumber. Handle of the tree item.

GetFont(name, size, enhancement)

Parameter	Type	Description
name	SalString&
size	SalNumber&
enhancement	SalNumber&

Returns: SalBoolean.

GetItemCount(hItem)

Gets the number of child items. If the handle argument is 0, then number of first level child items is returned.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalNumber. Number of items.

GetItemData(hItem)

Returns the numeric value assigned to the tree item.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalNumber. Numeric value assigned to the tree item.

GetItemParent(hItem)

Returns the handle of hItem's parent, or 0 if hItem is a top level child of the tree control.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalNumber. Handle of hItem's parent.

GetItemText(hItem)

Returns the string title of the item.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalString. String title of the item.

GetItemTooltip(hItem)

Returns the current tooltip for the tree item.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalString. Current tooltip for the tree item.

GetLabel()

Retrieves the window handle of the label (label control) that is associated with the hWndTarget parameter. There must be a mnemonic in that label, and it must immediately precede hWndTarget in the outline, or this function will fail.

Returns: SalWindowHandle.

GetLabelText(sText, nMaxLength)

Parameter	Type	Description
sText	SalString&
nMaxLength	SalNumber

Returns: SalNumber.

GetLabelText(nMaxLength)

Retrieves the text of the label associated to a control. Important: The label control does not require a mnemonic for the functions listed above to operate.

Parameter	Type	Description
nMaxLength	SalNumber

Returns: SalString.

GetLocation(x, y)

Parameter	Type	Description
x	SalNumber&
y	SalNumber&

Returns: SalBoolean.

GetName(text)

Parameter	Type	Description
text	SalString&

Returns: SalBoolean.

GetName()

Gets the name of an object.

Returns: SalString.

GetNextChild(typeMask)

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

Parameter	Type	Description
typeMask	SalNumber	One or more window types combined (using the OR (|) operator) to create a mask of child window types.

Returns: SalWindowHandle.

GetNextItem(hItem)

Gets the next sibling tree item of the passed tree item handle. Returns 0 if there are no more sibling tree items.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalNumber. Handle of the next tree item.

GetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

GetPrevItem(hItem)

Gets the previous sibling tree item of the passed tree item handle. Returns 0 if there are no more sibling items.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalNumber. Handle of the previous tree item.

GetProperty(name, value)

Parameter	Type	Description
name	SalString
value	SalString&

Returns: SalBoolean.

GetProperty(name)

Gets the value of a named property.

Parameter	Type	Description
name	SalString

Returns: SalString.

GetSelectedItem()

Returns the handle to the selected tree item, or 0 if no item is selected.

Returns: SalNumber. Handle to the selected tree item, or 0 if no item is selected.

GetSize(width, height)

Parameter	Type	Description
width	SalNumber&
height	SalNumber&

Returns: SalBoolean.

GetText(text, maxLen)

Parameter	Type	Description
text	SalString&
maxLen	SalNumber

Returns: SalNumber.

GetText(maxLen)

Retrieves the text of a window.

Parameter	Type	Description
maxLen	SalNumber

Returns: SalString.

GetWindowColor(colorIndex)

Gets a window's color.

Parameter	Type	Description
colorIndex	SalNumber

Returns: SalNumber.

GetWindowState()

Returns a window's current state.

Returns: SalNumber.

HideWindow()

Hides a window.

Returns: SalBoolean.

HideWindowAndLabel()

Hides a window and its associated label.

Returns: SalBoolean.

InsertItem(hItem, nIndex, sTitle)

Inserts a tree item into the tree control. The new item will be a child of hItem . If hItem is 0, the tree item is added as a top level child of the tree control. If nIndex is greater than or equal to the number of child items, or if nIndex is less than zero, the new item is appended.

Parameter	Type	Description
hItem	SalNumber	Handle of the tree item which will be the parent of the new item.
nIndex	SalNumber	Index to insert (starting at zero).
sTitle	SalString	Title of the new item.

Returns: SalNumber. Handle of the newly created item.

InvalidateWindow()

Causes a window to be repainted.

Returns: SalBoolean.

IsDerivedFromClass(typeClass)

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

Parameter	Type	Description
typeClass	Type

Returns: SalBoolean.

IsEnabled()

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

Returns: SalBoolean.

IsModified()

Returns the setting of the Field Edit Flag for a data field, multi line field, combo box, table window's context row cell, or picture.

Returns: SalBoolean.

IsVisible()

Determines whether a window is currently visible.

Returns: SalBoolean.

ItemHasCheckBox(hItem)

Returns true if the tree item has a checkbox displayed.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the item has a checkbox displayed, FALSE if not.

ItemIsChecked(hItem)

Returns true if the item checkbox is checked. Returns false if the checkbox is not displayed.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the checkbox is checked. If the checkbox is not checked, or is not displayed, bIsChecked is FALSE.

ItemIsExpanded(hItem)

Returns whether the item is expanded.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the item is expanded, FALSE if not.

ItemIsSelected(hItem)

Returns whether the item is selected.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the item is selected, FALSE if not.

ItemsHaveCheckBoxes()

Returns true if the tree shows checkboxes next to the items.

Returns: SalBoolean. TRUE if the items have a checkbox displayed, FALSE if not.

KillTimer(idEvent)

Destroys an object's system timer.

Parameter	Type	Description
idEvent	SalNumber

Returns: SalBoolean.

MoveDownItem(hItem)

Moves a tree item downward. This functions fails if the tree item is the last child of its parent.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

MoveItem(hItem, hParentItem, nPosition)

Moves a tree node and all its sub-nodes to a new location in the tree control.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
hParentItem	SalNumber	Handle to the new parent tree item.
nPosition	SalNumber	Position in the new parents list of children to place the new child (0-n).

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

MoveUpItem(hItem)

Moves a tree item upward . This functions fails if the tree item is the first child of its parent.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

MoveWindow(xOffset, yOffset)

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

Parameter	Type	Description
xOffset	SalNumber
yOffset	SalNumber

Returns: SalBoolean.

PixelsToFormUnits(numPixels, vertical)

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	SalNumber
vertical	SalBoolean	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.

PostMessage(msg, mywParam, mylParam)

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

Parameter	Type	Description
msg	SalNumber
mywParam	SalNumber
mylParam	SalNumber

Returns: SalBoolean.

PromoteItem(hItem)

Moves a tree item so it becomes the sibling of its parent. This functions fails if the tree item has no grandparent.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

Reset(bRemove)

Clears a tree control with the option to retain or destroy design-time nodes.

Parameter	Type	Description
bRemove	SalBoolean	TRUE = Remove all nodes. FALSE = Remove nodes created dynamically; the tree goes back to the initial state.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it does not succeed.

SendMessage(msg, mywParam, mylParam)

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

Parameter	Type	Description
msg	SalNumber
mywParam	SalNumber
mylParam	SalNumber

Returns: SalNumber.

SendMessageToChildren(msg, mywParam, mylParam)

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

Parameter	Type	Description
msg	SalNumber
mywParam	SalNumber
mylParam	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, flags)

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

Parameter	Type	Description
menuType	Type
flags	SalNumber

Returns: SalBoolean.

SetCursor(resource, type)

Sets a window's cursor.

Parameter	Type	Description
resource	SalResourceCursor
type	SalNumber

Returns: SalBoolean.

SetCursor(resourceId, type)

Sets a window's cursor.

Parameter	Type	Description
resourceId	Int32
type	SalNumber

Returns: SalBoolean.

SetCursor(blob, type)

Sets a window's cursor from a string variable.

Parameter	Type	Description
blob	SalString
type	SalNumber

Returns: SalBoolean.

SetCursorFile(file, type)

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
file	SalString
type	SalNumber

Returns: SalBoolean.

SetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandle.

SetFont(name, size, enhancement)

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

Parameter	Type	Description
name	SalString
size	SalNumber
enhancement	SalNumber

Returns: SalBoolean.

SetItemChecked(hItem, bChecked)

Sets or clears the checkbox. If the checkbox is not displayed, this function has no effect.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
bChecked	SalBoolean	TRUE to set the box as checked, FALSE to clear the checkbox.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

SetItemData(hItem, nValue)

Sets the numeric value of the tree item.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
nValue	SalNumber	Value to set.

Returns: SalNumber. Value that was previously assigned to the tree item.

SetItemEditable(hItem, bEditable)

Sets whether the tree item's label can be edited. If bEditable is true, the label can be edited.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
bEditable	SalBoolean	Whether to enable or disable editing.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

SetItemFontEnh(hItem, nFontEnh)

Sets the font enhancement for a tree item.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
nFontEnh	SalNumber	Font mask. Combine the following: FONT_EnhDefault, FONT_EnhNormal, FONT_EnhItalic, FONT_EnhUnderline, FONT_EnhBold.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

SetItemImage(hItem, bSelected, sImageFile)

Sets the image of a tree item. If the bSelected parameter is true, the selected image is set; otherwise the non-selected image is set.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
bSelected	SalBoolean	If TRUE, use selected image. If FALSE, use non-selected image.
sImageFile	SalString	Filename of the image.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

SetItemImageFromBinary(hItem, bSelected, nFormat, bPicture)

Sets the image of a tree item. If the bSelected parameter is true, the selected image is set; otherwise the non-selected image is set.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
bSelected	SalBoolean	If TRUE, use selected image. If FALSE, use non-selected image.
nFormat	SalNumber	The format of the picture contents: PIC_FormatBitmap, PIC_FormatIcon, PIC_FormatObject
bPicture	SalBinary	The image data to be assigned to the tree node.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

SetItemImageFromResource(hItem, bSelected, tResource)

Sets the image of a tree item. If the bSelected parameter is true, the selected image is set; otherwise the non-selected image is set.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
bSelected	SalBoolean	If TRUE, use selected image. If FALSE, use non-selected image.
tResource	SalResource	Resource object.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

SetItemText(hItem, sText)

Sets the title of the item.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
sText	SalString	Text to set as the title for this tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

SetItemTextColor(hItem, nColor)

Sets the text color of the tree item.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
nColor	SalNumber	Color to set.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

SetItemTooltip(hItem, sTooltip)

Sets the tooltip for the tree item.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
sTooltip	SalString	Tooltip text.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

SetLabelText(sText)

Sets the text of the associated label control.

Parameter	Type	Description
sText	SalString

Returns: SalBoolean.

SetLocation(x, y)

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

Parameter	Type	Description
x	SalNumber
y	SalNumber

Returns: SalBoolean.

SetModified(bSet)

Sets or clears the field edit flag for an editable data field, combo box, multi line text field, table window column, or picture.

Parameter	Type	Description
bSet	SalBoolean

Returns: SalBoolean.

SetProperty(name, value, length)

Sets the value of a named property.

Parameter	Type	Description
name	SalString
value	SalString
length	SalNumber

Returns: SalBoolean.

SetSelectedItem(hItem)

Selects a tree item.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

SetSize(width, height)

Resizes a window.

Parameter	Type	Description
width	SalNumber
height	SalNumber

Returns: SalBoolean.

SetText(text)

Sets the text of a window.

Parameter	Type	Description
text	SalString

Returns: SalBoolean.

SetTimer(idEvent, elapseMilliSec)

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
idEvent	SalNumber
elapseMilliSec	SalNumber

Returns: SalBoolean.

SetWindowColor(colorIndex, color)

Sets a window's color.

Parameter	Type	Description
colorIndex	SalNumber
color	SalNumber

Returns: SalBoolean.

ShowItemCheckBox(hItem, bShow)

Shows or hides the checkbox for a tree item.

Parameter	Type	Description
hItem	SalNumber	Handle to the tree item.
bShow	SalBoolean	TRUE to show the checkbox, FALSE to hide it.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

ShowItemsCheckBoxes(bShow)

Shows or hides the checkboxes for the tree control.

Parameter	Type	Description
bShow	SalBoolean	TRUE to show the checkboxes, FALSE to hide it.

Returns: SalBoolean. TRUE if the function succeeds and FALSE if it fails.

ShowWindow()

Makes a window visible.

Returns: SalBoolean.

ShowWindowAndLabel()

Makes a window and its associated label visible. A label is the label control that immediately precedes the window in the outline.

Returns: SalBoolean.

TrackPopupMenu(menuName, flags, x, y)

Creates pop-up menus at runtime.

Parameter	Type	Description
menuName	SalString
flags	SalNumber
x	SalNumber
y	SalNumber

Returns: SalBoolean.

TrackPopupMenu(menuType, flags, x, y)

Creates pop-up menus at runtime.

Parameter	Type	Description
menuType	Type
flags	SalNumber
x	SalNumber
y	SalNumber

Returns: SalBoolean.

UpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

WinHelp(file, command, numData, strData)

Starts the Windows help system.

Parameter	Type	Description
file	SalString
command	SalNumber
numData	SalNumber
strData	SalString

Returns: SalBoolean.

Yield()

Processes messages for this control.

Events

MessageActions

SalMessageHandler Message Actions

WindowActions

WindowActionsEventHandler Window Actions

Implements

Name	Description
ISalControl	All SAL controls implement this interface.
ISalWindow	All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface.