hilitePattern

Typeproperty
DictionaryLCS
LibraryLiveCode Script
Syntax
set the hilitePattern of <object> to {<patternNumber> | <imageID> | empty}
Synonymsmarkerpattern,thirdpattern
Associationsstack, card, field, button, graphic, scrollbar, player, image, group
Summary

Specifies the fill pattern used for the background when an object, or text in an object, is highlighted.

Introduced1.0
OSmac, windows, linux, ios, android
Platformsdesktop, server, mobile
Example
set the hilitePattern to 3859
Values
NameTypeDescription
Value

The hilitePattern of an object is a pattern specifier. A patternNumber is a built-in pattern number between 1 and 164. These patterns are provided for compatibility with patterns available in MetaCard and correspond to LiveCode's built in image id 137 to 300. As with MetaCard pattern numbers 105 to 114 and 146 and above are unavailable.

An imageID is the ID of an image to use for a pattern. LiveCode looks for the specified image first in the current stack, then in other open stacks.

By default, the hilitePattern for all objects is empty.

RelatedKeyword: field, image, button, menu, card, graphic, scrollbar, control, player
Property: bottomPattern, hiliteFill, pixels, hiliteColor, markerLineSize, height, backgroundPattern, lookAndFeel, menuMode, backgroundColor
Command: global, group
Function: stacks
Glossary: object, owner, current stack, tabbed button, property, highlight, button menu, Windows, select, Mac OS, Unix, object type, selection, EPS
Object: button, stack
Description

Use the hilitePattern property to specify the background pattern used for the selected text in a field, or the highlighted pattern of a clicked object, or the pattern of graphic markers.

Pattern images can be color or black-and-white.

*Cross-platform note:* To be used as a pattern on Mac OS systems, an image must be 128x128 pixels or less, and both its height and width must be a power of 2. To be used on Windows and Unix systems, height and width must be divisible by 8. To be used as a fully cross-platform pattern, both an image's dimensions should be one of 8, 16, 32, 64, or 128.

The hilitePattern of controls is drawn starting at the control's upper right corner: if the control is moved, the pattern does not shift.

The setting of the hilitePattern property has different effects, depending on the object type:

*Cross-platform note:* If the lookAndFeel is set to "Appearance Manager", standard and rectangle buttons are drawn by the operating system if the backgroundColor and backgroundPattern of the button and all of its owners is empty. In this case, the button's hilitePattern has no effect. Otherwise, the button is drawn by LiveCode. If the lookAndFeel is "Appearance Manager", button menus whose menuMode is set to "option" are always drawn by the operating system, and the setting of the button's hilitePattern does not affect them.

If the object's hilitePattern is set, the pattern is shown instead of the color specified by hiliteColor.

Note: Unlike the hiliteColor property, the hilitePattern is not a global property. Setting the hilitePattern of an object to empty causes the hilitePattern of the object's owner to be used for the object.

Tagsui