<doc>

<legacy_id>1115</legacy_id>

<name>borderPattern</name>

<type>property</type>

<syntax>

<example>set the borderPattern of <i>object</i> to {empty | <i>patternID </i>| <i>imageID</i>}</example>

</syntax>

<library></library>

<objects>

<stack/>

<card/>

<group/>

<field/>

<button/>

<graphic/>

<scrollbar/>

<player/>

<image/>

</objects>

<synonyms>

</synonyms>

<classification>

<category>Appearance &amp; Positioning</category>

</classification>

<references>

<keyword tag="effective">effective Keyword</keyword>

<property tag="borderColor">borderColor Property</property>

<property tag="borderWidth">borderWidth Property</property>

<property tag="shadowPattern">shadowPattern Property</property>

<property tag="patterns">patterns Property</property>

<property tag="foregroundPattern">foregroundPattern Property</property>

<property tag="markerFilled">markerFilled Property</property>

<property tag="threeD">threeD Property</property>

</references>

<history>

<introduced version="1.0">Added.</introduced>

</history>

<platforms>

<mac/>

<windows/>

<linux/>

<ios/>

<android/>

</platforms>

<classes>

<desktop/>

<server/>

<web/>

<mobile/>

</classes>

<security>

</security>

<summary>Specifies the pattern of an <glossary tag="object">object's</glossary> border.</summary>

<examples>

<example>set the borderPattern of group "Nav" to myPattern</example>

</examples>

<description>

<p>Use the <b>borderPattern</b> <glossary tag="property">property</glossary> to specify the border pattern of a <keyword tag="button">button</keyword> or <keyword tag="scrollbar">scrollbar</keyword>.</p><p/><p><b>Value:</b></p><p>The <b>borderPattern</b> of an <glossary tag="object">object</glossary> is a pattern specifier.</p><p/><p>A <i>patternNumber</i> is a built-in pattern number between 1 and 164. (These patterns correspond to LiveCode's built-in patterns 136 to 300.)</p><p/><p>An <i>imageID</i> is the ID of an <keyword tag="image">image</keyword> to use for a pattern. LiveCode looks for the specified <keyword tag="image">image</keyword> first in the <glossary tag="current stack">current stack</glossary>, then in other open <function tag="stacks">stacks</function>.</p><p/><p>By default, the <b>borderPattern</b> for all <glossary tag="object">objects</glossary> is empty.</p><p/><p><b>Comments:</b></p><p>Pattern images can be color or black-and-white.</p><p/><p><code/><img src="202652"/> <b>Cross-platform note:</b><code/> To be used as a pattern on <glossary tag="Mac OS">Mac OS systems</glossary>, an <keyword tag="image">image</keyword> must be 128x128 <property tag="pixels">pixels</property> or less, and both its <property tag="height">height</property> and <property tag="width">width</property> must be a power of 2. To be used on <function tag="openStacks">Windows</function> and <glossary tag="Unix">Unix systems</glossary>, <property tag="height">height</property> and <property tag="width">width</property> 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.</p><p/><p>The <b>borderPattern</b> of <glossary tag="control">controls</glossary> is drawn starting at the <glossary tag="control">control's</glossary> upper right corner: if the <keyword tag="control">control</keyword> is moved, the pattern does not shift.</p><p/><p>Setting the <b>borderPattern</b> of an <glossary tag="object">object</glossary> to empty allows the <b>borderPattern</b> of the <glossary tag="object">object's</glossary> <property tag="owner">owner</property> to show through. Use the <keyword tag="effective">effective</keyword> <glossary tag="keyword">keyword</glossary> to find out what color is used for the <glossary tag="object">object</glossary>, even if its own <b>borderPattern</b> is empty.</p><p/><p>If the object's <b>showBorder</b> <glossary tag="property">property</glossary> is false, the <b>borderPattern</b> has no effect.</p><p/><p>The setting of the <b>borderPattern</b> <glossary tag="property">property</glossary> has different effects, depending on the <glossary tag="object type">object type</glossary>:</p><p/><p>* The <b>borderPattern</b> of a <object tag="stack">stack</object>, <keyword tag="card">card</keyword>, or <command tag="group">group</command> determines the <b>borderPattern</b> of each <glossary tag="object">object</glossary> in the <object tag="stack">stack</object>, <keyword tag="card">card</keyword>, or <command tag="group">group</command> that does not have its own <b>borderPattern</b>.</p><p/><p>* The <b>borderPattern</b> of a <keyword tag="button">button</keyword> determines the pattern of the border around the <keyword tag="button">button</keyword>. If the <glossary tag="button">button's</glossary> <property tag="style">style</property> is<code> checkbox</code> or<code> radioButton</code>, the <b>borderPattern</b> has no effect. If the <keyword tag="button">button</keyword> is a <glossary tag="button menu">button menu</glossary>, the <b>borderPattern</b> has no effect unless the <glossary tag="button">button's</glossary> <property tag="menuMode">menuMode</property> <glossary tag="property">property</glossary> is set to<code> comboBox </code>or<code> popup</code>. If the button's <property tag="threeD">threeD</property> <glossary tag="property">property</glossary> is set to true, the <b>borderPattern</b> has no effect regardless of the <glossary tag="button">button's</glossary> <property tag="style">style</property>.</p><p/><p>* The <b>borderPattern</b> of a <keyword tag="field">field</keyword> has no effect, except for the border around a scrolling <glossary tag="field">field's</glossary> scrollbar. The <glossary tag="field">field's</glossary> <b>borderPattern</b> also determines the pattern of the outline around any text in the <keyword tag="field">field</keyword> whose <property tag="textStyle">textStyle</property> is set to "box".</p><p/><p>* The <b>borderPattern</b> of a <keyword tag="scrollbar">scrollbar</keyword> determines the pattern of the border surrounding the <keyword tag="scrollbar">scrollbar</keyword>.</p><p/><p>* The <b>borderPattern</b> of a <keyword tag="graphic">graphic</keyword>, <glossary tag="audio clip">audio clip</glossary>, <glossary tag="video clip">video clip</glossary>, or <keyword tag="image">image</keyword> has no effect.</p><p/><p>* The <b>borderPattern</b> of a <keyword tag="player">player</keyword> or <object tag="EPS">EPS</object> <glossary tag="object">object</glossary> determines the pattern of the border around the <glossary tag="object">object</glossary>. If the <glossary tag="object">object's</glossary> <property tag="threeD">threeD</property> <glossary tag="property">property</glossary> is set to true, the <b>borderPattern</b> has no effect.</p><p/><p>If an object's <b>borderPattern</b> is set, the pattern is shown instead of the color specified by <property tag="borderColor">borderColor</property>.</p>

</description>

</doc>