Specification of the configuration file

PREV
NEXT

The following example shows the basic structure of configuration XML file:

<?xml version = "1.0" encoding = "utf-8"> 
<config 
  xmlSourceCache = "true"
  loadGalleryBy="Categories"
  backgroundColor="0x000000"
  backgroundTransparent="1"
  backgroundFile="gallery_files/background.jpg"
  backgroundPosition="Center"
  backgroundFullscreenPosition="Stretch"
  backgroundLineColor="0x909090"
  backgroundLineTransparent="0.3"
  backgroundLineMargin="30"
  logoFile="gallery_files/logo.png"
  logoMarginTop="40"
  logoMarginBottom="10"
  copyrightFontFamily="Bavaria Regular"
  copyrightFontSize="8"
  copyrightFontColor="0x505050"
  copyrightCaption="FLASHDEVELOPMENT24.COM"
  soundFile="gallery_files/sound.mp3"
  soundLoop="true"
  soundVolume="0.3"
  soundEffectsEnabled="true"
  buttonIconColor="0xF0F0F0"
  buttonIconHighlight="0x3A669C"
  categoriesSpaceWidth="20"
  categoriesFontFamily="Aurora"
  categoriesFontColor="0x707070"
  categoriesFontHighlight="0xF0F0F0"
  categoriesFontSize="8"
  categoriesArrowColor="0xF0F0F0"
  categoriesAmountFontFamily="Bavaria Regular"
  categoriesAmountFontColor="0x3A669C"
  categoriesAmountFontSize="8"
  pagesMargin="40"
  pagesSpaceWidth="5"
  pagesFontFamily="Aurora"
  pagesFontColor="0x707070"
  pagesFontHighlight="0xF0F0F0"
  pagesFontSelected="0xFFFFFF"
  pagesFontSize="8"
  pagesArrowColor="0xF0F0F0"
  pagesMarkerWidth="18"
  pagesMarkerHeight="21"
  pagesMarkerColor="0x3A669C"
  pagesMarkerTransparent="1"
  pagesPreviousCaption="PREV PAGE"
  pagesNextCaption="NEXT PAGE"
  gridScaleX="0.6"
  gridScaleY="0.8"
  gridAutoSize="true"
  cellRows="3"
  cellColumns="5"
  cellWidth="120"
  cellHeight="135"
  cellSpaceWidth="10"
  cellCornerRadius="0"
  cellBgColor="0xFFFFFF"
  cellBgTransparent="1"
  cellBgHighlight="0xFFFFFF"
  cellBgHighlightTransparent="1"
  cellBorderThickness="0"
  cellBorderColor="0x909090"
  cellBorderTransparent="1"
  cellShadowDistance="2"
  cellShadowTransparent="0.7"
  cellShadowBlur="4"
  cellShadowColor="0x000000"
  cellShadowEnabled="true"
  thumbWidth="95"
  thumbHeight="95"
  thumbBgColor="0xD5D5D5"
  thumbBgTransparent="1"
  thumbCornerRadius="0"
  thumbBorderThickness="0"
  thumbBorderColor="0x909090"
  thumbBorderTransparent="1"
  thumbLoadingColor="0x909090"
  thumbAlign="Middle"
  thumbScaleScript=""
  thumbScaleMode="Crop"
  thumbMotionDuration="0.5"
  thumbBrightenAmount="1.2"
  thumbZoomAmount="1.2"
  thumbDesaturateEnabled="false"
  thumbReflectionRatio="0.2"
  thumbReflectionTransparent="0.3"
  thumbReflectionDistance="0"
  thumbReflectionEnabled="true"
  thumbShadowDistance="1"
  thumbShadowTransparent="0.5"
  thumbShadowBlur="2"
  thumbShadowColor="0x000000"
  thumbShadowInner="true"
  thumbShadowEnabled="true"
  captionFontFamily="Tahoma"
  captionFontSize="11"
  captionFontColor="0x505050"
  captionFontHighlight="0xC97C29"
  captionLinkUnderline="false"
  tipWidth="150"
  tipCornerRadius="5"
  tipBgColor="0x303030"
  tipBgTransparent="0.8"
  tipFontFamily="Tahoma"
  tipFontSize="11"
  tipFontColor="0xCCCCCC"
  popupBgColor="0x000000"
  popupBgTransparent="0.5"
  popupFramePadding="10"
  popupFrameColor="0xFFFFFF"
  popupCornerRadius="10"
  popupLoadingColor="0x707070"
  popupFontFamily="Tahoma"
  popupFontSize="11"
  popupFontColor="0x505050"
  popupFontHighlight="0x5995DE"
  popupFontAlign="Left"
  popupOverHtml="true"
  popupSlideScaleX="0.75"
  popupSlideScaleY="0.75"
  popupSlideBgColor="0xCCCCCC"
  popupSlideBorderThickness="0"
  popupSlideBorderColor="0xA0A0A0"
  popupSlideBorderTransparent="1"
  popupSlideShadowDistance="1"
  popupSlideShadowTransparent="0.5"
  popupSlideShadowBlur="2"
  popupSlideShadowColor="0x000000"
  popupSlideShadowInner="true"
  popupSlideShadowEnabled="true"
  popupControlCornerRadius="10"
  popupControlBgColor="0x707070"
  popupControlBgHighlight="0x3A669C"
  popupControlBgTransparent="0.8"
  popupControlArrowColor="0xFFFFFF"
  popupControlFontFamily="Aurora"
  popupControlFontColor="0xF0F0F0"
  popupControlFontHighlight="0xFFFFFF"
  popupControlFontSize="8"
  popupControlCloseCaption="CLOSE"
  popupControlPrevCaption="PREV"
  popupControlNextCaption="NEXT"
  popupControlShadowEnabled="true"
  popupVideoControlColor="0x3A669C"
  popupVideoControlHighlight="0x5995DE"
  popupVideoTimelineWidth="200"
  popupVideoTimelineBgColor="0xAAAAAA"
  popupVideoTimelineColor="0x505050">
</config>

Attributes

  • xmlSourceCache

    A Boolean value that sets whether gallery.xml file is cached by the browser, acceptable values are (true) or not (false). Turn off this option if you are updating your gallery very often. Note: if you are testing component locally turn on this option.

  • loadGalleryBy

    Parameter specify how to display gallery wheter by categories, in this case it will show in the gallery page only images of one category OR by pages, in this case it will fill the gallery page with images from all categories according number of thumbnails. Acceptable values are "Categories" and "Pages".

  • backgroundColor

    Color of the gallery background. It will be displayed if you don't use any image as background.

  • backgroundTransparent

    Indicates the alpha transparency value of the gallery background. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • backgroundFile

    Image file that will be used as a gallery background.

  • backgroundPosition

    Position of the backgorund image. Acceptable values are "Crop", "Fit", "Stretch", "Center" and "Tile".

  • backgroundFullscreenPosition

    Position of the backgorund image in full screen mode. Acceptable values are "Crop", "Fit", "Stretch", "Center" and "Tile".

  • backgroundLineColor

    Color of two horizontal lines (at the top and bottom) in the fullscreen mode.

  • backgroundLineTransparent

    Indicates the alpha transparency value of the background lines. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • backgroundLineMargin

    Margin between line separators under Logo and over Copyright, in pixels.

  • logoFile

    Image file that will be used as a logo in the fullscreen.

  • logoMarginTop

    Top margin of the logo (between logo and edge of the gallery), in pixels.

  • logoMarginBottom

    Bottom margin of the logo (between logo and the horizontal line), in pixels.

  • copyrightFontFamily

    Font family of the copyright text.

  • copyrightFontSize

    Font size of the copyright text.

  • copyrightFontColor

    Font color of the copyright text.

  • copyrightCaption

    Caption of the copyright. Copyright is a text in the bottom of the gallery in fullscreen.

  • soundFile

    Sound file that is used as a background music. Support MP3 format.

  • soundLoop

    A Boolean value that indicates whether the sound is playing in a loop (true) or not (false).

  • soundVolume

    Indicates the sound volume. Valid values are from 0 to 1.

  • soundEffectsEnabled

    A Boolean value that indicates whether the sound effects on mouse over is turned on (true) or not (false).

  • buttonIconColor

    Color of the equalizer and fullscreen buttons.

  • buttonIconHighlight

    Highlight color of the equalizer and fullscreen buttons.

  • categoriesSpaceWidth

    Width between categories captions, in pixels.

  • categoriesFontFamily

    Font family of the categories captions.

  • categoriesFontColor

    Font color of the categories captions.

  • categoriesFontHighlight

    Font highlight color of the categories captions.

  • categoriesFontSize

    Font size of the categories captions.

  • categoriesArrowColor

    Color of the arrows in the categories captions.

  • categoriesAmountFontFamily

    Font family of the categories amount number.

  • categoriesAmountFontColor

    Font color of the categories amount number.

  • categoriesAmountFontSize

    Font size of the categories amount number.

  • pagesMargin

    Margin (left and right) between page numbers and page controls, in pixels.

  • pagesSpaceWidth

    Width between page numbers, in pixels.

  • pagesFontFamily

    Font family of the page control captions and page numbers.

  • pagesFontColor

    Font color of the page control captions and page numbers.

  • pagesFontHighlight

    Font highlight color of the page control captions and page numbers.

  • pagesFontSelected

    Font color of the selected page number.

  • pagesFontSize

    Font size of the selected page captions and numbers.

  • pagesArrowColor

    Color of the page arrows.

  • pagesMarkerWidth

    Width of the page number marker, in pixels.

  • pagesMarkerHeight

    Height of the page number marker, in pixels.

  • pagesMarkerColor

    Color of the page number marker.

  • pagesMarkerTransparent

    Indicates the alpha transparency value of the page number marker. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • pagesPreviousCaption

    Translated 'Previous' into another language.

  • pagesNextCaption

    Translated 'Next' into another language.

  • gridScaleX

    Parameter that specify how much percent from the available size will be taken for the grid width. Available size: in full screen mode available size is limited by the monitor display size. In initial mode available size is limited by the Flash Object size. 0.1 step = 10%

  • gridScaleY

    Parameter that specify how much percent from the available size will be taken for the grid height. Available size: in full screen mode available size is limited by the monitor display size. In initial mode available size is limited by the Flash Object size. 0.1 step = 10%

  • gridAutoSize

    A Boolean value that indicates whether the size of the gallery grid will be calculated automaticaly is turned on (true) or not (false). If this parameter is turned on so grid size will be calculated according scaleX and scaleY. If this parameter is turned off, so the grid size will be created according cellRows and cellColumns parameters.

  • cellRows

    Indicates the number of grid rows.

  • cellColumns

    Indicates the number of grid columns.

  • cellWidth

    Width of the cell, pixels.

  • cellHeight

    Heigtht of the cell, pixels.

  • cellSpaceWidth

    Width between cells, in pixels.

  • cellCornerRadius

    Radius of the cell corners, in pixels.

  • cellBgColor

    Background color of the cell.

  • cellBgTransparent

    Indicates the alpha transparency value of the cell background. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • cellBgHighlight

    Highlight color of the cell background.

  • cellBgHighlightTransparent

    Indicates the alpha transparency value of the cell background highlighting. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • cellBorderThickness

    Width of the cells borders, in pixels.

  • cellBorderColor

    Color of the cell border.

  • cellBorderTransparent

    Indicates the alpha transparency value of the cell border. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • cellShadowDistance

    Shadow distance from the cell, in pixels.

  • cellShadowTransparent

    Indicates the alpha transparency value of the cell shadow. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • cellShadowBlur

    Blur ammount of the cell shadow.

  • cellShadowColor

    Color of the cell shadow.

  • cellShadowEnabled

    A Boolean value that indicates whether the cell shadow is turned on (true) or not (false).

  • thumbWidth

    Width of the thumbnails inside grid cells, in pixels.

  • thumbHeight

    Height of the thumbnails inside grid cells, in pixels.

  • thumbBgColor

    Thumbnails background color.

  • thumbBgTransparent

    Indicates the alpha transparency value of the thumbnail background. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • thumbCornerRadius

    Corners radius of the thumbnails, in pixels.

  • thumbBorderThickness

    Width of the thumbnail border, in pixels.

  • thumbBorderColor

    Color of the thumbnail border.

  • thumbBorderTransparent

    Indicates the alpha transparency value of the thumbnail border. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • thumbLoadingColor

    Color of the thumbnail loading icon.

  • thumbAlign

    A string that specifies how to align thumbnail inside grid cells. Acceptable values are "Top", "Middle" and "Bottom".

  • thumbScaleScript

    The absolute or relative URL of the ASPX or PHP file that is used. A relative path must be relative to the HTML file. Absolute URLs must include the protocol reference, such as http://. Read more information about server script in the topic 'Using server scripts'.

  • NOTE: thumbnails can be creaetd in several ways - using Server scripts to create thumbnails. OR you can create thumbs using your own images, through thumb attribute and set link to this file, which will be used as a thumbnail. If the server scripts are turned off and you didn't specify thumb attribute, so thumbnails will be created from the main (original) images.

  • thumbScaleMode

    A string that specifies how to scale thumbnail inside grid cells. Acceptable values are "Crop" and "Fit".

  • thumbMotionDuration

    Duration of the thumbnails motion effect, in seconds.

  • thumbBrightenAmount

    Brightness amount of the thumbnails.

  • thumbZoomAmount

    Zoom amount of the thumbnail motion effect. If number is positive zoom effect will be IN. If number is negative zoom effect will be OUT.

  • thumbDesaturateEnabled

    A Boolean value that indicates whether the thumbnails are desaturated (true) or not (false).

  • thumbReflectionRatio

    Size of the reflection. Valid values are 0 (no reflection) to 1 (fully reflected).

  • thumbReflectionTransparent

    Indicates the alpha transparency value of the thumbnails reflection. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • thumbReflectionDistance

    Distnace between reflection from thumbnail and thumbnail itself, in pixels.

  • thumbReflectionEnabled

    A Boolean value that indicates whether the thumbnails have reflection (true) or not (false).

  • thumbShadowDistance

    Distance between thumbnail and its shadow, in pixels.

  • thumbShadowTransparent

    Indicates the alpha transparency value of thumbnail shadow. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • thumbShadowBlur

    Blur ammount of thumbnail shadow.

  • thumbShadowColor

    Color of thumbnail shadow.

  • thumbShadowInner

    A Boolean value that indicates whether the thumbnails have inner shadow (true) or not (false).

  • thumbShadowEnabled

    A Boolean value that indicates whether the thumbnails have shadow (true) or not (false).

  • captionFontFamily

    Font family of the thumbnails caption.

  • captionFontSize

    Font size of the thumbnails caption.

  • captionFontColor

    Font color of the thumbnails caption.

  • captionFontHighlight

    Font highlight color of the thumbnails caption.

  • captionLinkUnderline

    A Boolean value that indicates whether the links in caption (if you've set hyperlink to thumbnail) are underlined (true) or not (false).

  • tipWidth

    Width of the floating tip, in pixels.

  • tipCornerRadius

    Corners radius of the floating tip, in pixels.

  • tipBgColor

    Background color of the floating tip, in pixels.

  • tipBgTransparent

    Indicates the alpha transparency value of tip background. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • tipFontFamily

    Font family of the text in floating tip.

  • tipFontSize

    Font size of the text in floating tip.

  • tipFontColor

    Font color of the text in floating tip.

  • popupBgColor

    Background color of the popup window.

  • popupBgTransparent

    Indicates the alpha transparency value of popup background. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • popupFramePadding

    Padding between thumbnail and edge of the frame in popup window, in pixels.

  • popupFrameColor

    Color of the frame in popup window.

  • popupCornerRadius

    Corners radius of the popup window.

  • popupLoadingColor

    Color of the image loading icon in popup window.

  • popupFontFamily

    Font family of the text in popup window.

  • popupFontSize

    Font size of the text in popup window.

  • popupFontColor

    Font color of the text in popup window.

  • popupFontHighlight

    Font highlight color of the text in popup window.

  • popupFontAlign

    A string that specifies how to align image description in popup window. Acceptable values are "Left", "Right", "Center" and "Justify".

  • popupOverHtml

    A Boolean value that indicates whether the popup window will be displayed over the whole page (true) or not, just over Flash Object (false).

  • popupSlideScaleX

    Width of the slide in percents from the window size. 0.1 = 10%

  • popupSlideScaleY

    Height of the slide in percents from the window size. 0.1 = 10%

  • popupSlideBgColor

    Background color of the slide in popup window.

  • popupSlideBorderThickness

    Width of the slide border in popup window, in pixels.

  • popupSlideBorderColor

    Color of the slide border in popup window.

  • popupSlideBorderTransparent

    Indicates the alpha transparency value of slide border in popup window. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • popupSlideShadowDistance

    Shadow distance from the slide frame in popup window.

  • popupSlideShadowTransparent

    Indicates the alpha transparency value of shadow from slide frame. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • popupSlideShadowBlur

    Blur ammount of the shadow from slide frame.

  • popupSlideShadowColor

    Color of the shadow from slide frame.

  • popupSlideShadowInner

    A Boolean value that indicates whether the slide frame has inner shadow (true) or not (false).

  • popupSlideShadowEnabled

    A Boolean value that indicates whether the slide frame has shadow (true) or not (false).

  • popupControlCornerRadius

    Corners radius of the controls in popup window, in pixels.

  • popupControlBgColor

    Background color of the cotrols in popup window.

  • popupControlBgHighlight

    Background highlight color of the cotrols in popup window.

  • popupControlBgTransparent

    Indicates the alpha transparency value of controls background. Valid values are 0 (fully transparent) to 1 (fully opaque).

  • popupControlArrowColor

    Color of the arrows in controls in popup window.

  • popupControlFontFamily

    Font family of the controls captions in popup window.

  • popupControlFontColor

    Font color of the controls captions in popup window.

  • popupControlFontHighlight

    Font highlight color of the controls captions in popup window.

  • popupControlFontSize

    Font size of the controls captions in popup window.

  • popupControlCloseCaption

    Translated 'Close' into another language.

  • popupControlPrevCaption

    Translated 'Prev' into another language.

  • popupControlNextCaption

    Translated 'Next' into another language.

  • popupControlShadowEnabled

    A Boolean value that indicates whether the controls in popup have shadow (true) or not (false).

  • popupVideoControlColor

    Color of the controls for the video.

  • popupVideoControlHighlight

    Highlight color of the controls for the video.

  • popupVideoTimelineWidth

    Width of the timeline, in pixels.

  • popupVideoTimelineBgColor

    Background color of the timeline.

  • popupVideoTimelineColor

    Color of the timeline.