User Tools

Site Tools


sheet_control_properties.htm
Navigation:  Window and Report Control Properties >====== Sheet Control Properties ====== Previous pageReturn to chapter overviewNext page

The SHEET control declares a group of TAB controls that offer the user multiple “pages” of controls for the window. The multiple TAB controls in the SHEET structure define the “pages” displayed to the user.

NoteBox.jpg

The Property View presents you with two ways to viewing a control's properties.

At the top of the Property View, press the categorized button categorized.jpg to view a control's properties by category (the deafult).

Or press the alphabetical button alphabetical.jpg to view a control's properties in alphabetical order.

This help documents displays the properties in the categorical view.

Color

Enter a valid color equate in the BackGround and TextColor fields, or press the ellipsis (…) button to select a color from the Color dialog. The Window Designer adds the COLOR attribute to your control declaration.

See ..\LIBSRC\EQUATES.CLW for a list of valid color equates.

Design

Design settings control visual elements you see in the Window Designer. These settings should not affect the window display at runtime.

Locked “Freezes” the control so that subsequent data dictionary changes are not applied. You can override the #Freeze attribute for all controls or for individual controls. See Application Options.
Tab Index Determines the index in the TAB order that this control will follow. The first tab in the order is index zero (0).To change the TabIndex property immediately while in the Designer, use the Show tab order interface (i.e. on the right-click menu).If you set the TabIndex property using the property page, the z-order is not updated until you save and exit the Window Designer.
UseVisualStyles Set to TRUE to display this control in a Visual Style appearance (as if the XP manifest was active)

Extra

Drop ID To specify the type of Drag operations this control will accept, type up to 16 signatures, separated by commas. The Window Designer adds the DROPID attribute to the control, which indicates the control is a valid target for the drag and drop operations identified by the signatures.
Scrolling Use the drop-down list to specify tabs scrolling behavior by choosing one of the following selections:
NoScrolling The tabs do not scroll. This is the default.
JoinedButtons Tabs are scrollable, with adjacent scroll buttons. adds the JOINED attribute to the SHEET. See the Language Reference for more information.
SpreadButtons Tabs are scrollable, with scroll buttons at opposite ends of the sheet. Adds the HSCROLL attribute to the SHEET. See the Language Reference for more information.

General

Layout Indicates the orientation of the control. Left to Right maintains the original layout specified in the Window Designer. Right to Left essentially “flips” the controls' display as a mirror image of the layout specified in the Window Designer. Default field navigation moves from right to left. The setting in the Application Frame will cascade its setting to all child windows and controls that have the default setting active.
Tab Location Use the drop-down list to set the location of the tabs for this SHEET. Choose from the following:
TabPosition Default The tabs run across the top of the sheet.
Left The tabs run down the left side of the sheet. This adds the LEFT(width) attribute to the SHEET.
Right The tabs run down the right side of the sheet. This adds the RIGHT(width) attribute to the SHEET.
Above The tabs run across the top of the sheet. This adds the ABOVE(width) attribute to the SHEET.
Below The tabs run across the bottom of the sheet. Adds the BELOW(width) attribute to the SHEET.
Width Specify the tab width in dialog units.
This sets the value of the width parameter for the LEFT, RIGHT, ABOVE, or BELOW attribute. By setting this width, you can make all your tabs the same size, regardless of varying text lengths per tab.
Tab width is the distance between the edges of the tab that are perpendicular to the text orientation. That is, width determines how much space appears on either end of your tab's text, not how much space appears above and below the text. This is true, regardless of text orientation.
Tabs Press the ellipsis button to call the Collection Editor. Here, you can modify the properties of each individual tab
TextFont Calls the Font dialog which lets you select the font (typeface), size, style (such as bold or italic), color, and font effects (underline and strikeout) for the selected control or window. As you choose options, the dialog box displays a sample of the selected font.
Text Orientation Use the drop-down list to set the orientation of the tabs and their text. A Text Orientation other than Default requires a TrueType font. Choose from the following orientations:
Default The text reads left to right and the shape of the tab is a horizontal rectangle.
Up The text reads from bottom to top and the shape of the tab is a vertical rectangle. This adds the UP attribute to the SHEET.
Down The text reads from top to bottom and the shape of the tab is a vertical rectangle. This adds the DOWN attribute to the SHEET.
Inverted The text is upside down and the shape of the tab is a horizontal rectangle. This adds the UP and the DOWN attribute to the SHEET.
Use This defines the USE attribute for the control. Type a field equate label to reference the control in executable code, or the name of a variable.

NoteBox.jpg

To fit many tabs on a sheet, set the Justification to Above and set the Text Orientation to Up. Alternatively set the Justification to Right and set the Text Orientation to Default. Also, see Extra Tab to make scrolling tabs!

Help

Cursor The Cursor field (the CURSOR attribute) lets you specify an alternate shape for the cursor when the user passes the cursor over the control. The drop-down list provides standard cursor choices such as I-Beam and Crosshair. To select an external cursor file (whose extension must be .CUR), choose Select File from the drop-down list, then pick the file using the standard file dialog.
Key Enter the desired key or key combination (for example, CTRL+H). The keys you pressed will appear in the Key field, and will be supplied as parameters to the KEY or ALRT attribute for this control. The ESC, ENTER, and TAB keys cannot be specified by pressing them. For these keys, press the ellipsis (…) button and type “esc,” “enter,” or “tab.”

Mode

Disable Disables or 'grays-out' the control when your program initially displays it. The Window Designer places the DISABLE attribute on the control. Use the ENABLE statement to allow the user access to the control.
Hide Makes the control invisible at the time Windows would initially display it. Windows actually creates the control–it just doesn't display it on screen. The Window Designer places the HIDE attribute on the control. Use the UNHIDE statement to display the control.
Scroll Specifies whether the control should move with the window when the user scrolls the window. By default (False) the control does not move with the window. Set the Scroll property to False to create a control that stays fixed when the user scrolls the window. The Window Designer places the SCROLL attribute on the control when checked.

Position

Lets you set the location and size of the sheet and the tabs on the sheet.

The Position tab lets you specify the AT attribute. Filling in the attribute manually is optional–you may set the position and size visually by dragging with the mouse in the Window Designer.

To set the location of the control's Top Left Corner, set an X (horizontal) and Y (vertical) coordinate in Dialog units. The coordinate is relative to the top left corner of the window.

To set the control's size, choose from the following options for Width and Height.

Default The Clarion runtime library determines the size of the control based on the applicable font and picture token.
Full The control is the full height or width of the window.
Value Lets you set a precise width or height in Dialog units.

TabOptions

Immediate Specifies that EVENT:NewSelection generates whenever the user clicks on a TAB (even when that TAB is already the currently selected TAB). This can be useful when there are multiple SHEET controls on the same window.
NoSheet Set to True to erase the borders of the tab pages so that only the protruding selectable portion of the tab is visible. This has the additional effect of making tabs located above the sheet, fall to the bottom of the sheet, and making tabs located below the sheet rise to the top of the sheet. This adds the NOSHEET attribute to the SHEET. See the Language Reference for more information.
Spread Resizes the tabs on the TABs to fill all the available space on the SHEET. The resizing algorithm considers the length of the text displayed on each tab, the number of tabs, and the available space on the property sheet.
Wizard Hides the “tab” portion of the TAB controls. Hiding the tabs aids in creating a wizard. A wizard is a window with a “tabless” SHEET control containing one or more TABS. You'll need to write the code to handle the “turning of the pages”. See How to Create a Wizard.NoteBox.jpgDo not check this box until you are finished designing the window! Alternately, you can change the sheet to a wizard at runtime after opening the window using the ?Sheet{Prop:Wizard}=True property assignment.

Quick Links

Embeds Accesses the Embedded Source dialog for points surrounding the event handling for this control only.
sheet_control_properties.htm.txt · Last modified: 2021/04/15 15:57 (external edit)