TOC : Script API > JavaScript > JavaScript API > Component > Note >

 

Method

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

TOC : Script API > JavaScript > JavaScript API > Component > Note >

 

Method

 

 

Name

Description

ApplyFormat

Apply format to a component.

GetAlternativeText

Gets the alternate text.

GetAutoFontSize

Gets the option value for automatic controlling of font size.

GetBackgroundAlpha

Gets the background alpha value.

GetBackgroundColor

Gets the background color.

GetBand

Gets the band having the note.

GetBorderLocation

Gets the border location.

GetBottomBorderColor

Gets the color of the bottom border.

GetBottomBorderDash

Gets the dash pattern of the bottom border.

GetBottomBorderDashOffset

Gets the dash offset of the bottom border.

GetBottomBorderThickness

Gets the thickness of the bottom border.

GetBottomInternalMargin

Gets the internal bottom margin.

GetBottomNoteMargin

Gets the external bottom margin.

GetCharacterSpacing

Gets the character spacing.

GetComponentByName

Gets the component of the given name.

GetDataSetAVG

Gets the average from the given field.

GetDataSetCNT

Gets the number of dataset rows.

GetDataSetFREQ

Gets the occurrence count of the given value from the given field.

GetDataSetMAX

Gets the maximum value from the given field.

GetDataSetMIN

Gets the minimum value from the given field.

GetDataSetName

Gets the dataset name.

GetDataSetRowCount

Gets the number of total rows of the given data set.

GetDataSetRowIndex

Gets the cursor index of the current row.

GetDataSetSUM

Gets the sum from the given field.

GetDataSetValue

Gets the data value of the given field.

GetDataType

Gets the data type.

GetDrawingType

Gets the drawing type.

GetEffect

Gets the font effect.

GetExportOption

Get saving options for report exporting.

GetFieldName

Gets the field name.

GetFontName

Gets the font name.

GetFontSize

Gets the font size.

GetFontStretch

Gets the font scale.

GetFormat

Gets the text format.

GetGradientColor

Gets the gradient color.

GetGradientDirection

Gets the gradient direction.

GetGradientStartPosition

Gets the gradient start position.

GetHeight

Gets the height.

GetHorizontalTextAlignment

Gets the horizontal text alignment.

GetHorizontalWriteDirection

Gets the horizontal writing direction.

GetLeft

Gets the left position.

GetLeftBorderColor

Gets the color of the left border.

GetLeftBorderDash

Gets the dash pattern of the left border.

GetLeftBorderDashOffset

Gets the dash offset of the left border.

GetLeftBorderThickness

Gets the thickness of the left border.

GetLeftInternalMargin

Gets the left internal margin.

GetLineSpacing

Gets the line spacing.

GetName

Gets the name.

GetNullType

Gets the null type.

GetODIName

Gets the ODI name.

GetPage

Gets the page that has been added component.

GetParameterName

Gets the parameter name of a note.

GetParameterSetName

Gets the parameter set name of a note.

GetParent

Gets the parent component.

GetPreferedFontSize

Gets the base font size in which a text in a component can be displayed without exceeding the size of the component.

GetPreferedHeight

Gets the preferred height (the minimum height needed to accommodate the displayed text) for the crosstab header.

GetPreferedWidth

Gets the preferred width (the minimum width needed to accommodate the displayed text) for the crosstab header.

GetReport

Gets the current report component.

GetReportTemplate

Gets the report template.

GetResourceName

Gets the resource name.

GetRightBorderColor

Gets the color of the right border.

GetRightBorderDash

Gets the dash pattern of the right border.

GetRightBorderDashOffset

Gets the dash offset of the right border.

GetRightBorderThickness

Gets the thickness of the right border.

GetRightInternalMargin

Gets the internal right margin.

GetText

Gets the text.

GetTextColor

Gets the color of a text.

GetTextDirection

Gets the text direction.

GetTextIndent

Gets the text indent.

GetTextLineColor

Gets the line color of underline, strikeout, double strikeout.

GetTooltipText

Gets the tooltip text.

GetTop

Gets the top position.

GetTopBorderColor

Gets the color of the top border.

GetTopBorderDash

Gets the dash pattern of the top border.

GetTopBorderDashOffset

Gets the dash offset of the top border.

GetTopBorderThickness

Gets the thickness of the top border.

GetTopInternalMargin

Gets the internal top margin.

GetTopNoteMargin

Gets the external top margin.

GetUserValue

Gets the user defined value.

GetVerticalTextAlignment

Gets the vertical text alignment.

GetVerticalWriteDirection

Gets the vertical writing direction.

GetWidth

Gets the width.

GetWordWrapType

Gets the word wrap type.

IsChangeable

Indicates whether properties of the component on the viewer is changeable.

IsClipping

Indicates whether clipping is enabled.

IsCRLFToLF

Indicates whether to convert CRLF to LF.

IsDataSetLastRow

Indicates whether the current row cursor is on the last of the dataset.

IsDataSetValueNull

Indicates whether the field value is null.

IsEditable

Indicates whether the component on the viewer is editable.

IsEnableToShrink

Indicates whether enabled to shrink.

IsFontBold

Indicates whether the font is bold.

IsFontItalic

Indicates whether the font is italic.

IsFontStrikeOut

Indicates whether the font is strikeout.

IsFontUnderLine

Indicates whether the font is underline.

IsMovable

Indicates whether the component on the viewer is movable.

IsPrintable

Indicates whether the component is printable.

IsShowBorder

Indicates whether to show border.

IsTransparent

Indicates whether the component is transparent.

IsUseGradient

Indicates whether to use gradient effect.

IsVisible

Indicates whether the component on the viewer is visible.

IsWordWrap

Indicates whether the word wrap is enabled on the component.

SetAlternativeText

Set the alternate text.

SetAutoFontSize

Set options for automatic controlling of font size.

SetBackgroundAlpha

Sets the background alpha value.

SetBackgroundColor

Sets the background color.

SetBorderLocation

Sets border location.

SetBottomBorderColor

Sets the color of the bottom border.

SetBottomBorderDash

Sets the dash pattern of the bottom border.

SetBottomBorderDashOffset

Sets the dash offset of the bottom border.

SetBottomBorderThickness

Sets the thickness of the bottom border.

SetBottomInternalMargin

Sets the internal bottom margin.

SetBottomNoteMargin

Sets the external bottom margin.

SetBrowserOption

Sets the options to control web browser screen that will display the report when linking the report.

SetChangeable

Sets whether properties of the component on the viewer is changeable.

SetCharacterSpacing

Sets character spacing.

SetClipping

Set clipping.

SetCRLFToLF

Sets whether to convert CRLF to LF.

SetDataSetName

Sets the dataset name.

SetDataType

Sets the data type.

SetDrawingType

Sets the drawing type.

SetEditable

Sets whether the component on the viewer is editable.

SetEffect

Sets the font effect.

SetEnableToShrink

Set whether to enable shrinking.

SetExportOption

Set saving options for report exporting.

SetFieldName

Sets the field name.

SetFontBold

Sets whether the font is bold.

SetFontItalic

Sets whether the font is italic.

SetFontName

Sets the font name.

SetFontSize

Sets the font size.

SetFontStretch

Sets the font scale.

SetFontStrikeOut

Sets whether the font is strikeout.

SetFontUnderLine

Sets whether the font is underline.

SetFormat

Sets the font format.

SetGradientColor

Sets the gradient color.

SetGradientDirection

Sets the gradient direction.

SetGradientStartPosition

Sets the gradient start position.

SetHeight

Sets the height.

SetHorizontalTextAlignment

Sets the horizontal text alignment.

SetHorizontalWriteDirection

Sets the horizontal writing direction.

SetLeft

Sets the left position.

SetLeftBorderColor

Sets the color of the left border.

SetLeftBorderDash

Sets the dash pattern of the left border.

SetLeftBorderDashOffset

Sets the dash offset of the left border.

SetLeftBorderThickness

Sets the thickness of the left border.

SetLeftInternalMargin

Sets the internal left margin.

SetLineSpacing

Sets the line spacing.

SetLinkEvent

Set to raise the link event and pass argument values to external events(OZLinkCommand, OZUserActionCommand).

SetLinkExecute

Sets the command to execute by the link.

SetLinkOption

Sets the value of the OZ viewer parameter for the report  to be linked.

SetLinkParam

Sets the value of the form parameter for the report  to be linked.

SetLinkPostURL

Call and display the web browser URL of the target frame using POST method.

SetLinkRepository

Execute or save the file on the server repository.

SetLinkServer

Request a report to OZ daemon type server.

SetLinkServlet

Request a report to OZ servlet type server.

SetLinkToc

Set TOC label.

SetLinkURL

Call and display the web browser URL of the target frame.

SetMovable

Sets whether the component on the viewer is movable.

SetODIName

Sets the ODI name.

SetParameterName

Sets the parameter name of the parameter note.

SetParameterSetName

Sets the parameter set name of the parameter note.

SetPrintable

Set whether the component is printable.

SetResourceName

Set the resource name.

SetRightBorderColor

Sets the color of the right border.

SetRightBorderDash

Sets the dash pattern of the right border.

SetRightBorderDashOffset

Sets the dash offset of the right border.

SetRightBorderThickness

Sets the thickness of the right border.

SetRightInternalMargin

Sets the internal right margin.

SetShowBorder

Set whether to show the border.

SetText

Sets the text.

SetTextColor

Sets the color of a text.

SetTextDirection

Sets the text direction.

SetTextIndent

Sets the text indent.

SetTextLineColor

Sets the line color of underline, strikeout, double strikeout.

SetTooltipText

Sets the tooltip text.

SetTop

Sets the top position.

SetTopBorderColor

Sets the color of the top border.

SetTopBorderDash

Sets the dash pattern of the top border.

SetTopBorderDashOffset

Sets the dash offset of the top border.

SetTopBorderThickness

Sets the thickness of the top border.

SetTopInternalMargin

Sets the internal top margin.

SetTopNoteMargin

Sets the external top margin.

SetTransparent

Sets whether the component is transparent.

SetUseGradient

Sets whether to use gradient effect.

SetUserValue

Assigns a user defined value to the user value.

SetVerticalTextAlignment

Sets the vertical text alignment.

SetVerticalWriteDirection

Sets the vertical writing direction.

SetVisible

Sets whether the component on the viewer is visible.

SetWidth

Sets the width.

SetWordWrap

Sets whether to enable word wrap.

SetWordWrapType

Sets the word wrap type.