UI/Frame Properties

Frame Properties

Most of the frame customization is done through frame properties, including its dimensions, colors, visibility, tooltips, etc.

General Usage

All the content items in this section are used inside a frame markup like this:

<Frame name="myCustomFrame">
  <myproperty attribute="1"/>
  <Visible val="true"/>
</Frame>

Property List

• AcceptsMouse
• AcceptsMouseTooltip
• AdjustmentColor
• AllowAutoPageWrap
• AllowCameraCentering
• AllowCursorChanging
• AllowDisableMinimapSmartCommand
• AllowedButtons
• AllowPageWrap
• AllowSelection
• AllowTargeting
• AllyColor
• AllyRenderPriority
• Alpha
• AlphaLayer
• AlphaMaskTexture
• AlwaysShow
• Anchor
• Animating
• AnimColumns
• AnimCount
• AnimDuration
• ApplyLanguageRules
• ArrowHoverImage
• ArrowImage
• AutoIncrement
• AutoPlay
• AutoSizeFillBar
• BackgroundColor
• BackgroundImage
• BackgroundShown
• BackgroundVisible
• BarCount
• BaseTexture
• Batch
• BatchText
• BestValueGrouping
• BlendMode
• BlurAmount
• BorderImage
• BufferingImage
• Button
• Camera
• CampaignId
• CampaignLink
• CategoryId
• CheckImage
• CheckSound
• ClearSelectionIfNotVisible
• ClickOnContextMenu
• ClickSound
• CollapseLayout
• Color
• ColorAdjustMode
• ColorStep
• CommanderId
• CompositionLabel
• ConsoleWorldBottomOffset
• ConsoleWorldTopOffset
• ContextMenu
• ContextMenuButtons
• Continuous
• CountdownSound
• CountdownTime
• CustomTeamColor
• CycleDelay
• DecreaseDuration
• DecrementButton
• DefaultIcon
• DefaultState
• DefaultTexture
• Desaturated
• DesaturateOnDisable
• DesaturationColor
• DescFlags
• DifficultyIndex
• DisabledAlpha
• DisplayBackgroundModel
• DisplayCancelCommandCard
• DisplayForegroundUI
• DisplayType
• DrawLineToCursor
• Enabled
• EnabledDuringRestrictedState
• EnabledInStarterEdition
• EnabledWhileInParty
• EnemyColor
• EnemyRenderPriority
• FadeDuration
• Fading
• File
• FillBar2Image
• FillBarImage
• FillContainer
• FillInset
• FlashInputEnabled
• FolderIcon
• FormatNumber
• FrameLogoAlias
• Handle
• Height
• HideUnusedButtons
• HideWhenCleared
• HighlightAlpha
• HighlightColor
• HighlightImage
• HighlightOnFocus
• HighlightOnGainFocus
• HighlightOnHover
• HitTestFrame
• HitTestPrecision
• HitTestRequireValidTarget
• HitTestTexture
• HoverImage
• HoverSound
• IgnoreEmotes
• IgnoreGraphicsQuality
• IgnoreMinimapPings
• IgnoreParentAlpha
• IgnoreParentColor
• IgnoreUpgradesWithoutLevel
• IgnoreWorldPings
• Image
• IncreaseDuration
• IncrementButton
• IncrementSound
• Inverted
• Item
• ItemClickSound
• ItemContainer
• ItemDesc
• ItemGap
• ItemHeight
• ItemHoverWhileDisabled
• ItemIndent
• Label
• LanguageLabel
• LayerAlpha
• LayerColor
• LayerCount
• LayerVisible
• LinkedModalFrame
• LockAspectRatio
• Loop
• LoopingAnim
• ManagedAnim
• MaxCharacters
• MaxLength
• MaxMessages
• MaxValue
• MaxVisibleAspectRatio
• MaxWidth
• Menu
• MenuGap
• MenuHiddenSound
• MenuMaxHeight
• MenuMaxWidth
• MenuMinWidth
• MenuShownSound
• MessageArea
• MessageDuration
• MinValue
• MinVisibleAspectRatio
• MinWidth
• Model
• ModelLink
• MovieFrame
• Muted
• NormalImage
• NydusLink
• Options
• Orientation
• OwnerColor
• OwnerRenderPriority
• Panel
• PanelListItem
• PasswordMode
• PauseAllowed
• PausedImage
• Position
• PreserveAnchorOffset
• ProgressSlider
• Projection
• ReadingLabel
• ReductionColor
• ReductionShown
• RejectsFocus
• RenderBackground
• RenderBorder
• RenderPriority
• RenderType
• ReportsStats
• RequiredDefines
• RequireSelection
• Rotation
• SaveScrollHeightOnClear
• Scale
• ScaleAlphaToTerrain
• ScaleHeightToTexture
• ScaleWidthToTexture
• ScoreValue
• ScoreValueLink
• ScreenSingleMode
• ScrollBar
• Segmented
• SegmentValue
• SelectedImage
• SettingName
• Shortcut
• ShowComplete
• ShowDelay
• ShowKilled
• ShowOnDefeat
• ShowOnVictory
• ShowPrice
• ShowStructures
• ShowUnits
• ShowWhenReplaying
• Sorted
• SortIconsByDuration
• StartupTexture
• StateCount
• StepValue
• StreamingAllowed
• Style
• SubpixelRendering
• TabListItem
• TeamColorIndex
• Text
• Texture
• TextureType
• Tiled
• Toggleable
• ToneMapping
• Tooltip
• TooltipAnchorPosition
• TooltipFrame
• TopToBottom
• TurningEnabled
• Unclipped
• UnitLink
• UpIcon
• UpString
• UseAlternateTime
• UseAnchors
• UseAspectScaling
• UsedSoundCategories
• UseExactName
• UseFillContainer
• UseGridHotkeys
• UseScrollBar
• UseShadows
• UseStandardCoordinates
• UseTransition
• ValueChangeSound
• Version
• VersusModePlayerSide
• VisibilityOnFade
• Visible
• WarningTimeSeconds
• Width
• WrapUV
• WriteOutText
• WriteOutTextDuration

About UI item sizes and anchors

A UI objects size can be determined in one of three ways:

1. Setting the objects size through use of height and width val contents
2. Using anchors to determine it's size (Will only work if the size val for the selected set of sides is not set)
3. A combination of the above

Ex 1:

<Frame type="Frame" name="myCustomFrame">

 <Width val="250"/>
 <Height val="250"/>

</Frame>

This would create a Frame item of the size 250x by 250y

Ex 2

       <Frame type="Image" name="CommandPanelBorder">
           <Anchor side="Top" relative="$parent/CommandPanel" pos="Min" offset="-26"/>
           <Anchor side="Bottom" relative="$parent/CommandPanel" pos="Max" offset="125"/>
           <Anchor side="Left" relative="$parent/CommandPanel" pos="Min" offset="-33"/>
           <Anchor side="Right" relative="$parent/CommandPanel" pos="Max" offset="32"/>
       </Frame>

This would create an image item that would stick out from the commandpanel by 26 on the top, 125 on the bottom, 33 from the left, and 32 from the right. This would adjust dynamically according to the size of the command panel.

Ex 3

           <Frame type="Image" name="VLine">
               <Width val="3"/>
               <Anchor side="Top" relative="$parent" pos="Min" offset="0"/>
               <Anchor side="Bottom" relative="$parent" pos="Max" offset="0"/>
               <Anchor side="Left" relative="$parent/CommandPanel" pos="Max" offset="0"/>
           </Frame>

This would create an image item that would 3 pixels wide, but extend from the top of it's parent item, all the way to the bottom, anchored to the far right of the command panel.