Resource Element (Data)

From HLKitWiki
Revision as of 02:42, 25 November 2008 by Rob (Talk | contribs)

Jump to: navigation, search

Context: HL KitKit Reference … Structural File Reference 

The "resource" Element

Everything associated with fonts, colors, bitmaps and borders is managed via resources. Each visual attribute used within your data files is specified through the use of a "resource" element. The complete list of attributes for this element is below.

id Id – Specifies the unique id of the resource. This id is used in all references to the resource.
isbuiltin (Optional) Boolean – Indicates whether the resource is a "built-in" resource provided by HL for easy re-use. Only bitmaps and borders can be built-in resources, since fonts and colors can be freely defined at any time. Default: "no".
issystem (Optional) Boolean – Indicates whether the resource is intended to replace a "system" resource utilized by HL. When you want to completely change the visual look of your data files and have that new look integrated into HL's own forms, you will need to specify system resources. Only specific resource ids can be replaced as system resources. Default: "no".

The "resource" element also possesses child elements that define the specifics of the resource. The list of these child elements is below and must appear in the order shown. Click on the link to access the details for each element.

IMPORTANT! Exactly one of these child elements may be specified for each resource. If multiple are given, a compiler error will be reported.

color An optional "color" element may appear as defined by the given link. This element specifies the details of a color resource.
font An optional "font" element may appear as defined by the given link. This element specifies the details of a font resource.
bitmap An optional "bitmap" element may appear as defined by the given link. This element specifies the details of a bitmap resource.
solid An optional "solid" element may appear as defined by the given link. This element specifies the details of a solid-color border resource.
border An optional "border" element may appear as defined by the given link. This element specifies the details of a bitmap-based border resource.

The "color" Element

The "color" element defines the facets of a color resource. The complete list of attributes for this element is below.

color Text – Color value to be used in the format "xxxxx". The format for the color uses standard HTML color syntax, with each character representing a hexadecimal digit. The first two characters define the Red color value, the next two Green, and the last two Blue. For example, the color "ff0080" specifies a Red value of "ff", a Green value of "00", and a Blue value of "80".

NOTE! For additional details on specifying colors via the HTML syntax, please refer to one of the many websites that provide this information, such as http://www.w3schools.com/Html/html_colors.asp.

The "font" Element

The "font" element defines the facets of a font resource. The complete list of attributes for this element is below.

x x –
x x –
x x –

The "bitmap" Element

The "bitmap" element defines the facets of a bitmap resource. The complete list of attributes for this element is below.

x x –
x x –
x x –

The "solid" Element

The "solid" element defines the facets of a solid-color border resource. The complete list of attributes for this element is below.

x x –
x x –
x x –

The "border" Element

The "border" element defines the facets of a bitmap-based border resource. The complete list of attributes for this element is below.

x x –
x x –
x x –

Example

The following example demonstrates what various "resource" elements might look like. All default values are assumed for optional attributes.