The type of pane.

Usage

Set_Property(OLECtrlEntID, "OLE.PaneType[index]", Array)

Values

Array has the following structure:

PosNameTypeDescriptionDefault
<1>TypeOptionThe pane type.Normal
<2>ParametersMultivalueThe pane type's optional parameters.""

Indices

IndexDescription
indexIndex to an existing pane

Remarks

The PaneType property establishes the type of pane. The pane's type affects behavior and appearance and can be used to active specific features. The PaneType property is composed of two fields: Type and Parameters.

The possible values for the Type field are:

ValueAbbr.Description
NormalNORThe Pane simply displays its caption and image according to the PaneAlignment and PaneEffect properties
ScrollingSCRThe Pane scrolls the caption and image from right to left according to the PaneScrollDelay property
SRP StatusSRPThe Pane automatically displays the StatusBarText properties of SRP ActiveX controls. This type ignores other pane properties, drawing only status bar text using the default window text color
Progress NormalPNThe Pane draws a progress bar behind the normal contents of the Pane
Progress PercentPPThe Pane draws a progress bar behind a centered caption showing the current value of the PanePercent property. The caption appears light over the progress bar and normal over the rest of the Pane.
Progress CaptionPCThe Pane draws a progress bar behind the caption (excluding any image). The caption appears light over the progress bar and normal over the rest of the Pane
Progress BlocksPBThe Pane draws a progress bar block by block
Progress MarqueePMThe Pane draws a progress bar using five blocks scrolling automatically left to right
NumLockNUMThe Pane automatically applies an effect when NumLock is off
CapLockCAPThe Pane automatically applies an effect when CapLock is off
ScrollLockSCRLKThe Pane automatically applies an effect when ScrollLock is off

Many cell types require extra data for initialization. The extra data is provided via the Parameters field of this property (field 2). See below for details.

Normal

Normal panes just display their captions and images. This is the default type.

Scrolling

Scrolling panes scroll their contents across themselves from right to left. You can control the speed of the scroll by setting the PaneScrollDelay property.

SRP Status

SRP Status panes communicate with SRP OLE Button controls to have their StatusBarText properties automatically appear within an SRP OLE Status Bar pane.

Progress Normal

Progress Normal panes just show their normal contents with a progress bar in the background. Use the PaneColors property to customize the progress bar appearance.

Progress Percent

Progress Percent panes show a progress bar with the percentage value as the caption, ignoring the PaneCaption and PaneImage properties. The percentage value is drawn lightly over the progress bar and normally over the remainder of the pane. Use the PaneColors property to customize the progress bar appearance.

Progress Caption

Progress Caption panes show a progress bar behind the pane's caption, ignoring the PaneImage property. The captions is drawn lightly over the progress bar and normally over the remainder of the pane. Use the PaneColors property to customize the progress bar appearance.

Progress Blocks

Progress Blocks type panes show a progress bar composed of blocks, and they do not display any caption or image. To customize the width, in pixels, of each block, simply set the Parameters field to the desired width. Use the PaneColors property to customize the progress bar appearance.

Progress Marquee

Progress Marquee panes show an animated progress bar composed of five progress blocks scrolling left to right. This type of pane is useful when you need to indicate that work is being done but you cannot calculate the amount of work remaining. To customize the width, in pixels, of each block, simply set the Parameters field to the desired width. Use the PaneColors property to customize the progress bar appearance. You can control the speed of the marquee by setting the PaneMarqueeDelay property.

NumLock

NumLock panes automatically respond to the NumLock key. When NumLock is off, then an effect is applied. To select an effect, simply choose one of the PaneEffect values. When NumLock is on, then the caption appears normally.

CapLock

CapLock panes automatically respond to the CapLock key. When CapLock is off, then an effect is applied. To select an effect, simply choose one of the PaneEffect values. When CapLock is on, then the caption appears normally.

ScrollLock

ScrollLock panes automatically respond to the ScrollLock key. When ScrollLock is off, then an effect is applied. To select an effect, simply choose one of the PaneEffect values. When ScrollLock is on, then the caption appears normally.

Example

// We're gonne set the types of 6 panes 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneCount", 6) 

// Make pane 1 an SRP Status pane 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneType[1]", "SRP") 

// Make pane 2 a scrolling pane and set it's speed 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneType[2]", "Scrolling") 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneScrollDelay[2]", 100) 

// Make pane 3 a normal progress bar 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneType[3]", "Progress Normal") 

// Make pane 3 a Percentage progress bar 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneType[3]", "Progress Percent") 

// Make pane 3 a captioned progress bar 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneType[3]", "Progress Caption") 

// Make pane 3 a block=style progress bar with 8-pixel-wide blocks 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneType[3]", "Progress Blocks":@FM:8) 

// Make pane 3 a Marquee progress bar with default block size 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneType[3]", "Progress Marquee") 

// Make pane 4 a NumLock pane 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneType[4]", "NumLock":@FM:"DIM") 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneCaption[4]", "NUM") 

* Make pane 5 a CapLock pane 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneType[5]", "CapLock":@FM:"DIM") 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneCaption[5]", "CAP") 

// Make pane 6 a NumLock pane 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneType[6]", "ScrollLock":@FM:"DIM") 
Set_Property(@Window:".OLE_STATUSBAR", "OLE.PaneCaption[6]", "SCROLL")

See Also

PanePercentPaneScrollDelayPaneMarqueeDelay

  • No labels