List of Snowflake.net Properties

 

 

In the following table are listed all properties used in the Snowflake.net 3.0 control.

 

 

Properties

Description

 

 

Appearance

AxesContentVisible

writes out the displayed axes under the title

AxesContentFont

specified the font for the Axes title display

BackButtonEnabled

set this property to true to enable "go back" functionality without using Snowflake menu. Back button (left arrow) become visible when an UI action is performed. If last performed action is zoom (drill-in), back button is replaced with the name of the zoomed member.

BackColor

background color for the whole control

BackImageUrl 

URL for the background image for the whole control

BorderColor

border color for the whole control

BorderStyle

border style for the whole control. One of:

·      Not Set

·      None

·      Dotted

·      Dashed

·      Solid

·      Double

·      Groove

·      Ridge

·      Inset

·      Outset

BorderWidth

in pixels

Caption

specifies the caption/title of the query

CaptionFont

specifies the font for the caption

CssClass

inherited, not used

Culture

format for totals use this property as well as language. For list of valid values check the drop-down box in the designer.

Note: This property deprecates the language property. Totals formatting includes thousands separator when data cells contain integers.

9 different language types:

·      German

·      English

·      Spanish

·      French

·      Italian

·      Portuguese

·      Serbian

·      Icelandic

·      Swedish

DownArrowUrl

url for the image for down arrow

Font

general font applicable to the control

ForeColor

general font color applicable to the control

Language

deprecated

QueryTextVisible

specifies if the MDX (or SQL) query will be visible

SpacerImageUrl

url for the spacer image

UpArrowUrl

url for the up arrow image

UseDrillImages

determines if the image urls should be used instead of default Snowflake images. Default for this property is False.

 

 

Behavior

AccessKey

not used

Enabled

enables the control. True by default.

EnableViewState

enables the view state tracking. True by default.

TabIndex

tab index on the web page

ToolTip

tool tip for the whole control

VerboseErrors 

show full MDX if any error occurs

Visible

sets the control visibility

XMLAPassword

fixed password for use with Basic Authentication

XMLAUserName

fixed user id for use with Basic Authentication

 

 

Chart

BeveledLook

support for beveled look with shadowing. Default is True.

CategoryAxis

determines what axis is on the category. Default - X

ChartBckColor

background color for the chart

ChartImageFormat

gif, jpg, png, bmp, png, …

ChartImageSubfolder

location of the temporary storage of the chart generated images

ChartPosition

bottom, top, left, right relative to grid

Chart area size/position is changing dynamically to ensure enough space for large values on the value axis

ChartSize

chart size in pixels

ChartType

15 different chart types:

·      Column

·      Column3D

·      ColumnStacked

·      ColumnStacked3D

·      Bar

·      Bar3D

·      BarStacked

·      BarStacked3D

·      Pie

·      Pie3D

·      Line

·      LineWithMarkers

·      Area

·      AreaStacked

·      Combo – line and bar (displays first 2 data series, regardless of actual number of data series in input data)

ChartVisible

display the chart

ComboChartBarSeries

default 1; applicable when Combo chart type is selected

ComboChartLineSeries

default 2; applicable when Combo chart type is selected

ComboChartValAxis2Enabled

TODO

LegendAutoCaption

(default false) for automatic setting; if true, has precedence over manual setting.

LegendCaption

force display of the measure name in the graph legend

LegendPosition

one of {Auto (default), Right, Beneath}

note: legend is displayed in 3 columns when there is more than 8 legend entries

MinLabelsFontSize

controls the minimum font size for axis labels at run-time

MaxDataPoints

controls the maximum number of data points displayed for situations where only one data serial is available

PercentDisplayCutOff

all the slices that have percent less than the cut-off will be lumped into the "other" category

note: this property is active when there's just one column or row in the dataset. Values under CutOff percent are grouped as "others" category

PieDataLabels

determines the labels that show in the pie chart. Options are percent, values, percent and values.

note: Pie charts resize themselves in order to make labels legible

ValuesInLegend

enables display of values in the legend. Default is true.

Note: when there's just one category and ValuesInLegend=true, data values are displayed in legend

 

 

ConditionalFormatting

ConditionalFormattingEnabled

(default false) specified if conditional formatting is to be applied

HighValuesColor

color for the high values

HighValuesFont

font for the high values

HighValuesThreshold

threshold value that determines what is considered high

InbetweenValuesColor

color for the in between values

InbetweenValuesFont

font for the in between values

LowValuesColor

color for the low values

LowValuesFont

font for the low values

LowValuesThreshold

threshold value that determines what is considered low

 

 

Data

DataBindings

leave empty

Catalog

name of catalog/database for query execution. Example: Foodmart 2000

DataSourceName

 

set to an existent XA data source name, as defined in {Xafolder}\config\dataSources.xml.

Example: Local Analysis Server

DrillThroughEnabled

enables the drill-through to underlying data when set to true

EmptyCellString

string to be displayed for empty cells. Default is empty string.

HttpCompression

 

selects compression type. Default is "none". Other option is "gzip".

note: compression can reduce the network traffic from XML/A provider to Snowflake.net by up to 90%.

 

NonEmptyOnly

Exclude MDX tuples with no data. Default is false.

QueryType

Set to MDX or SQL. Default is MDX

StartUpQuery

MDX or SQL Select sentence to be executed on startup

XMLATimeout

 

sets the timeout for the XML/A query (in milliseconds, default 10000)

XmlAURL

URL to Xml for Analysis provider. Default is http://localhost/XmlA/msxisapi.dll

RestrictedDimension

Restricted Dimensions are used as means of applying security for dimension members in the Snowflake layer. In many cases the SQL Server Analysis Services security is quite sufficient for implementing the security requirements. However, there are situations where the security information is better left in outside systems and for this particular situation the Snowflake Restricted Dimension support can be used.

Restricted dimension support is implemented through new design/run time property Data->RestrictedDimension (string eg. "Store" or "Store Type" without brackets) as well as the two new run-time public methods:

AddRestrictedDimensionTopNode(string UniqueNodeName)

ClearRestrictedDimensionTopNodes()

 

 

 

DataGrid

AdminBackColor

background color of the administration area

AdminForeColor

foreground color of the administration area

BoldTotals

totals will be bolded when set to true

ColsRemovingEnabled

when set to true the users can remove/hide columns by clicking on a little x in the column header

ColsSortingEnabled

when set to true the users can sort on columns by clicking on the sort arrows in the column header

DataBackColor

background color for the data grid cell elements

DataForeColor 

foreground color for the data grid cell elements

DataGridVisible

display data grid

DisableColorsHardCoding

when set to true, levels darkening is disabled.

FreeHiersPanelEnabled

when set to true the users can enable drag&drop of dimensions by clicking on the top-left cell of the grid

LevelsDarkening

determines the gradation of color darkening

MaxMemberNameLen

when set to non-zero value the member name will be truncated to this length

MembersBackColor

background color for the dimension member cells

MembersForeColor

foreground color for the dimension member cells

MembersNameWrap

when set to false the names will be truncated

OnClickMemberAction

when user clicks the member in the dimension there are 2 possible actions: zoom (drill-in) or isolate.

drill-in – filters on the selection and drills-down on it

isolate – filters on the selection but does not drill-down

PageSize

number of rows per page

PagingEnabled

display the result tuple in paged manner

/( when this property is set to true the grid will be displayed in pages with rows determined by the PageSize property. Navigation bar at the bottom of the grid is used for moving between the pages)/

RowsRemovingEnabled

when set to true the user can remove/hide rows by clicking on the x image in the header

RowsSortingEnabled

enable the sorting on the y-axis data members

SortingKeepsHierarchy

when true, the hierarchy structure is preserved and the tuple cells are sorted within the hierarchy, otherwise the pure sort of all elements of the tuple is performed

SumColumns

add subtotals for columns

SumRows

add subtotals for rows

TotalsBackColor

background color for the totals

TotalsForeColor

color for the totals

 

 

Layout

Height

height of the control

HorizontalAlign

alignment of the control with respect to the page

Width

width of the control

 

 

Menu

MenuBackColor

background color for the menu

MenuForeColor

foreground color for the menu

MenuVisible

Is the menu visible or not

 

 

Misc

Id

id of the control on the web page

 

 

Slice Panel

BrowserBackColor

background color for the dimensions browser

BrowserFont

font for the dimensions browser

BrowserForeColor

foreground color for the dimensions browser

NonDefaultMembersOnly

when set to true only the slicers where the user has set slice will be displayed. When set to false all slicers are displayed.

SliceBackColor

background color for the slice panel

SliceFont

font for the slice controls

SliceForeColor

foreground color for the slice panel

SliceMemberBackColor

background color for the slice controls

SliceMemberForeColor

foreground color for the slice controls

SliceVisible

sets visibility of the slice panel

 

 

 

 

images\imrcleft.gif

Copyright © 2004 Intellimerce Inc. All rights reserved.