LibreOffice API

LibreOffice にはドキュメントやスプレッドシート、スライド等にアクセスするための API (Application Program Interface) が用意されています。

目次

  1. ScCellObj
  2. ScCellRangeObj
  3. ScChartsObj
  4. ScTableSheetObj
  5. ScTableSheetsObj
  6. com.sun.star.chart.chartAxis
  7. com.sun.star.chart.DataSeries
  8. com.sun.star.awt.Point
  9. com.sun.star.awt.Rectangle
  10. com.sun.star.awt.Size
  11. com.sun.star.chart.LineDash
  12. com.sun.star.comp.chart.ChartLine
  13. com.sun.star.comp.chart.Diagram
  14. com.sun.star.comp.chart.Legend
  15. com.sun.star.comp.chart.Title
  16. com.sun.star.comp.chart2.ChartModel
  17. com.sun.star.table.CellRangeAddress
  18. stardiv.Toolkit.UnoCheckBoxControl
  19. stardiv.Toolkit.UnoDateFieldControl
  20. stardiv.Toolkit.UnoDialogControl
  21. stardiv.Toolkit.UnoListBoxControl
  22. stardiv.Toolkit.UnoNumericFieldControl
  23. stardiv.Toolkit.UnoRadioButtonControl
  24. ThisComponent

ScCellObj

ScCellObjはOpenOffice/LibreOfficeマクロBASICからCalcスプレッドシートのセルを操作するためのオブジェクトです。

プロパティの概要

ScCellObjのプロパティ一覧を次に示す。

プロパティ 概要
SbxSTRING AbsoluteName
SbxBOOL AsianVerticalMode
SbxOBJECT BottomBorder 底(下)の境界線
SbxLONG CellBackColor
SbxOBJECT CellProtection
SbxSTRING CellStyle
SbxLONG CharColor 文字の色
SbxBOOL CharContoured
SbxBOOL CharCrossedOut
SbxINTEGER CharEmphasis
SbxINTEGER CharFont
SbxINTEGER CharFontCharSet
SbxINTEGER CharFontCharSetAsian
SbxINTEGER CharFontCharSetComplex
SbxINTEGER CharFontFamily
SbxINTEGER CharFontFamilyAsian
SbxINTEGER CharFontFamilyComplex
SbxSTRING CharFontName
SbxSTRING CharFontNameAsian
SbxSTRING CharFontNameComplex
SbxINTEGER CharFontPitch
SbxINTEGER CharFontPitchAsian
SbxINTEGER CharFontPitchComplex
SbxSTRING CharFontStyleName
SbxSTRING CharFontStyleNameAsian
SbxSTRING CharFontStyleNameComplex
SbxSINGLE CharHeight
SbxSINGLE CharHeightAsian
SbxSINGLE CharHeightComplex
SbxOBJECT CharLocale
SbxOBJECT CharLocaleAsian
SbxOBJECT CharLocaleComplex
SbxLONG CharPosture
SbxLONG CharPostureAsian
SbxLONG CharPostureComplex
SbxINTEGER CharRelief
SbxBOOL CharShadowed
SbxINTEGER CharStrikeout
SbxINTEGER CharUnderline
SbxLONG CharUnderlineColor
SbxBOOL CharUnderlineHasColor
SbxSINGLE CharWeight
SbxSINGLE CharWeightAsian
SbxSINGLE CharWeightComplex
SbxBOOL CharWordMode
SbxBOOL ChartColumnAsLabel
SbxBOOL ChartRowAsLabel
SbxOBJECT ConditionalFormat
SbxOBJECT ConditionalFormatLocal
SbxOBJECT ConditionalFormatXML
SbxOBJECT DiagonalBLTR
SbxOBJECT DiagonalTLBR
SbxSTRING FormulaLocal
SbxLONG FormulaResultType
SbxLONG HoriJustify
SbxBOOL IsCellBackgroundTransparent
SbxBOOL IsTextWrapped
SbxOBJECT LeftBorder 左の境界線
SbxLONG NumberFormat 数の書式
SbxOBJECT NumberingRules
SbxLONG Orientation
SbxINTEGER ParaAdjust
SbxLONG ParaBottomMargin
SbxINTEGER ParaIndent
SbxBOOL ParaIsCharacterDistance
SbxBOOL ParaIsForbiddenRules
SbxBOOL ParaIsHangingPunctuation
SbxBOOL ParaIsHyphenation
SbxINTEGER ParaLastLineAdjust
SbxLONG ParaLeftMargin
SbxLONG ParaRightMargin
SbxLONG ParaTopMargin
SbxOBJECT Position セルの位置
SbxOBJECT RightBorder 右の境界線
SbxLONG RotateAngle
SbxLONG RotateReference
SbxOBJECT ShadowFormat
SbxBOOL ShrinkToFit
SbxOBJECT Size セルのサイズ
SbxOBJECT TableBorder
SbxOBJECT TopBorder 天(上)の境界線
SbxOBJECT UserDefinedAttributes
SbxOBJECT Validation
SbxOBJECT ValidationLocal
SbxOBJECT ValidationXML
SbxLONG VertJustify
SbxINTEGER WritingMode
SbxOBJECT PropertySetInfo
SbxSTRING PropertyToDefault
SbxDOUBLE NotANumber
SbxARRAY Data
SbxARRAY RowDescriptions
SbxARRAY ColumnDescriptions
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxARRAY Types
SbxARRAY ImplementationId
SbxOBJECT RangeAddress
SbxOBJECT Spreadsheet
SbxSTRING ArrayFormula
SbxARRAY DataArray
SbxARRAY FormulaArray
SbxBOOL IsMerged
SbxOBJECT Columns テーブル列オブジェクト
SbxOBJECT Rows
SbxOBJECT CellFormatRanges
SbxOBJECT UniqueCellFormatRanges
SbxSTRING Formula セルの数式
SbxDOUBLE Value セルの値
SbxLONG Type
SbxLONG Error
SbxOBJECT CellAddress セルアドレスオブジェクト
SbxOBJECT Text
SbxOBJECT Start
SbxOBJECT End
SbxSTRING String セルの文字列
SbxOBJECT ElementType
SbxOBJECT Annotation
SbxOBJECT TextFields
SbxOBJECT TextFieldMasters
SbxINTEGER ActionLocks
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

メソッドの概要

ScCellObjのメソッド一覧を次に示す。

メソッド 概要
SbxEMPTY queryInterface ( SbxOBJECT )
SbxOBJECT getPropertySetInfo ( void )
SbxVOID setPropertyValue ( SbxSTRING, SbxVARIANT )
SbxEMPTY getPropertyValue ( SbxSTRING )
SbxVOID addPropertyChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID removePropertyChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID addVetoableChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID removeVetoableChangeListener ( SbxSTRING, SbxOBJECT )
SbxOBJECT getPropertySetInfo ( void )
SbxVOID setPropertyValues ( SbxARRAY, SbxARRAY )
SbxARRAY getPropertyValues ( SbxARRAY )
SbxVOID addPropertiesChangeListener ( SbxARRAY, SbxOBJECT )
SbxVOID removePropertiesChangeListener ( SbxOBJECT )
SbxVOID firePropertiesChangeEvent ( SbxARRAY, SbxOBJECT )
SbxLONG getPropertyState ( SbxSTRING )
SbxARRAY getPropertyStates ( SbxARRAY )
SbxVOID setPropertyToDefault ( SbxSTRING )
SbxEMPTY getPropertyDefault ( SbxSTRING )
SbxDOUBLE computeFunction ( SbxLONG )
SbxVOID clearContents ( SbxLONG ) セルの内容をクリアする
SbxVOID addChartDataChangeEventListener ( SbxOBJECT )
SbxVOID removeChartDataChangeEventListener ( SbxOBJECT )
SbxDOUBLE getNotANumber ( void )
SbxBOOL isNotANumber ( SbxDOUBLE )
SbxARRAY getData ( void )
SbxVOID setData ( SbxARRAY )
SbxARRAY getRowDescriptions ( void )
SbxVOID setRowDescriptions ( SbxARRAY )
SbxARRAY getColumnDescriptions ( void )
SbxVOID setColumnDescriptions ( SbxARRAY )
SbxVOID decrementIndent ( void )
SbxVOID incrementIndent ( void )
SbxOBJECT queryVisibleCells ( void )
SbxOBJECT queryEmptyCells ( void )
SbxOBJECT queryContentCells ( SbxINTEGER )
SbxOBJECT queryFormulaCells ( SbxLONG )
SbxOBJECT queryColumnDifferences ( SbxOBJECT )
SbxOBJECT queryRowDifferences ( SbxOBJECT )
SbxOBJECT queryIntersection ( SbxOBJECT )
SbxOBJECT queryDependents ( SbxBOOL )
SbxOBJECT queryPrecedents ( SbxBOOL )
SbxOBJECT createSearchDescriptor ( void )
SbxOBJECT findAll ( SbxOBJECT )
SbxOBJECT findFirst ( SbxOBJECT )
SbxOBJECT findNext ( SbxOBJECT, SbxOBJECT )
SbxOBJECT createReplaceDescriptor ( void )
SbxLONG replaceAll ( SbxOBJECT )
SbxVOID addModifyListener ( SbxOBJECT )
SbxVOID removeModifyListener ( SbxOBJECT )
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxINT64 getSomething ( SbxARRAY )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxOBJECT getRangeAddress ( void )
SbxOBJECT getCellByPosition ( SbxLONG, SbxLONG )
SbxOBJECT getCellRangeByPosition ( SbxLONG, SbxLONG, SbxLONG, SbxLONG )
SbxOBJECT getCellRangeByName ( SbxSTRING )
SbxOBJECT getSpreadsheet ( void )
SbxSTRING getArrayFormula ( void )
SbxVOID setArrayFormula ( SbxSTRING )
SbxARRAY getDataArray ( void )
SbxVOID setDataArray ( SbxARRAY )
SbxARRAY getFormulaArray ( void )
SbxVOID setFormulaArray ( SbxARRAY )
SbxVOID setTableOperation ( SbxOBJECT, SbxLONG, SbxOBJECT, SbxOBJECT )
SbxVOID merge ( SbxBOOL )
SbxBOOL getIsMerged ( void )
SbxVOID fillSeries ( SbxLONG, SbxLONG, SbxLONG, SbxDOUBLE, SbxDOUBLE )
SbxVOID fillAuto ( SbxLONG, SbxLONG )
SbxVOID autoFormat ( SbxSTRING )
SbxARRAY createSortDescriptor ( void )
SbxVOID sort ( SbxARRAY )
SbxOBJECT createFilterDescriptor ( SbxBOOL )
SbxVOID filter ( SbxOBJECT )
SbxOBJECT createFilterDescriptorByObject ( SbxOBJECT )
SbxOBJECT createSubTotalDescriptor ( SbxBOOL )
SbxVOID applySubTotals ( SbxOBJECT, SbxBOOL )
SbxVOID removeSubTotals ( void )
SbxOBJECT getColumns ( void )
SbxOBJECT getRows ( void )
SbxARRAY createImportDescriptor ( SbxBOOL )
SbxVOID doImport ( SbxARRAY )
SbxOBJECT getCellFormatRanges ( void )
SbxOBJECT getUniqueCellFormatRanges ( void )
SbxSTRING getFormula ( void )
SbxVOID setFormula ( SbxSTRING )
SbxDOUBLE getValue ( void )
SbxVOID setValue ( SbxDOUBLE )
SbxLONG getType ( void )
SbxLONG getError ( void )
SbxOBJECT getCellAddress ( void )
SbxOBJECT getText ( void )
SbxOBJECT getStart ( void )
SbxOBJECT getEnd ( void )
SbxSTRING getString ( void )
SbxVOID setString ( SbxSTRING )
SbxOBJECT createTextCursor ( void )
SbxOBJECT createTextCursorByRange ( SbxOBJECT )
SbxVOID insertString ( SbxOBJECT, SbxSTRING, SbxBOOL )
SbxVOID insertControlCharacter ( SbxOBJECT, SbxINTEGER, SbxBOOL )
SbxVOID insertTextContent ( SbxOBJECT, SbxOBJECT, SbxBOOL )
SbxVOID removeTextContent ( SbxOBJECT )
SbxOBJECT getElementType ( void )
SbxBOOL hasElements ( void )
SbxOBJECT createEnumeration ( void )
SbxOBJECT getAnnotation ( void )
SbxOBJECT getTextFields ( void )
SbxOBJECT getTextFieldMasters ( void )
SbxBOOL isActionLocked ( void )
SbxVOID addActionLock ( void )
SbxVOID removeActionLock ( void )
SbxVOID setActionLocks ( SbxINTEGER )
SbxINTEGER resetActionLocks ( void )

プロパティの詳細

セル・オブジェクトのプロパティ
名前 種類 説明
AbsoluteName String
AsianVerticalMode Boolean
CellBackColor Long
CellProtection com.sun.star.util.CellProtection
CellStyle String
CharContoured Boolean
CharCrossedOut Boolean
CharEmphasis Integer
CharFont Integer
CharFontCharSet Integer
CharFontCharSetAsign Integer
CharFontCharSetComplex Integer
CharFontFamily Integer
CharFontFamilyAsian Integer
CharFontFamilyComplex Integer
CharFontName String
CharFontNameAsian String
CharFontNameComplex String
CharFontPitch Integer
CharFontPitchAsian Integer
CharFontPitchComplex Integer
CharFontStyleName String
CharFontStyleNameAsian String
CharFontStyleNameComplex String
CharHeight Single
CharHeightAsian Single
CharHeightComplex Single
CharLocale com.sun.star.lang.Locale
CharLocaleAsian com.sun.star.lang.Locale
CharLocaleComplex com.sun.star.lang.Locale
CharPosture Long
CharPostureAsian Long
CharPostureComplex Long
CharRelief Integer
CharShadowed Boolean
CharStrikeout Integer
CharUnderline Integer
CharUnderlineColor Long
CharWeight Single
CharWeightAsian Single
CharWeightComplex Single
CharWordMode Boolean
CharColumnAsLabel Boolean
CharRowAsLabel Boolean
ConditionalFormat ScTableConditionalformat
ConditionalFormatLocal ScTableConditionalformat
ConditionalFormatXML ScTableConditionalformat
DiagonalBLTR com.sun.star.table.BorderLine
DiagonalTLBR com.sun.star.table.BorderLine
FormulaLocal String
FormulaResultType Long
HoriJustify Long
IsCellBackgroundTransparent Boolean
IsTextWrapped Boolean
NumberingRules AvxUnoNumberingRules
Orientation Long
ParaAjust Integer
ParaBottomMargin Long
ParaIndent Integer
ParaIsCharacterDistance Boolean
ParaIsForbiddenRules Boolean
ParaIsHangingPunctuation Boolean
ParaIsHyphenation Boolean
ParaLastLineAdjust Integer
ParaLeftMargin Long
ParaRightMargin Long
ParaTopMargin Long
RorateAngle Long
RotateReference Long
ParaTopMargin Long
ShadowFormat com.sun.star.table.ShadowFormat
ShrinkToFit Boolean
TableBorder com.sun.star.table.TableBorder
UserDefinedAttributes SvUnoAttributeContainer
Validation ScTableValidationObject
ValidationLocal ScTableValidationObject
ValidationXML ScTableValidationObject
VertJustify Long
WritingMode Object
PropertyToDefault String
NotANumber Double
Data Object
RowDescriptions String

BottomBorder

底(下)の境界線を表すcom.sun.star.table.BorderLineオブジェクト

CharColor

Dim Formula As Long

セルの文字の色

使用例
Dim oCell As Object

oCell = ThisComponent.Sheets(0).getCellByPosition(0, 0)
oCell.CharColor = RGB(255, 0, 255)

LeftBorder

左の境界線を表すcom.sun.star.table.BorderLineオブジェクト

NumberFormat

Dim NumberFormat As Long

数の書式

セルに数値を表示する際、いろいろな書式で表示することができます。たとえば、千単位で区切ったり、小数点以下の桁数を指定したり、先頭の0を表示するか否かなどを指定することができます。数値の書式を指定するには、セル・オブジェクトやRangeオブジェクトのNumberFormatプロパティを設定します。

NumberFormatプロパティに設定するのは、Long型の数値です。この値と書式との関係を次に示します。

書式 書式コード
0 Standard Standard
1 -1234 0
2 -1234.12 0.00
3 -1,234 #,##0
4 -1,234.12 #,##0.00
5 -1,234.12 #,###.00
10 -13% 0%
11 -12.95% 0.00%
36 1999/12/31 YYYY/MM/DD
37 99/12/31 YY/MM/DD
101 -\1,234 [$¥-411]#,##0;-[$¥-411]#,##0
102 -\1,234.00 [$¥-411]#,##0.00;-[$¥-411]#,##0.00

セルの書式設定をする例を次に示します。この例では、数値を千単位で区切り、小数点以下の桁は表示しないように設定しています。

Dim oCell As Object

oCell = ThisComponent.Sheets(0).getCellByPosition(0, 0)
oCell.NumberFormat = 3
oCell.Value = 1234.12

セル・オブジェクトではなく、RangeオブジェクトのNumberFormatプロパティを設定すれば、まとめて複数のセルの書式を設定することができます。

Position

セルの位置を表すcom.sun.star.awt.Pointオブジェクト

RightBorder

右の境界線を表すcom.sun.star.table.BorderLineオブジェクト

Size

セルのサイズを表すcom.sun.star.awt.Sizeオブジェクト

TopBorder

天(上)の境界線を表すcom.sun.star.table.BorderLineオブジェクト

Columns

テーブル列オブジェクト(ScTableColumnObj)

Dim oCell As Object
Dim ElementName As String

oCell = ThisComponent.Sheets(0).getCellByPosition(0, 0)
ElementName  = oCell.Columns.ElementNames(0)

Formula

Dim Formula As String

セルの数式

使用例
Dim oCell As Object

oCell = ThisComponent.Sheets(0).getCellByPosition(0, 0)
oCell.Formula = "=Sum(A1:A20)"

Value

Dim Value As Double

セルの値

日付を代入したい場合は、Date型の値を指定する必要があります。Date型の値ではなく、日付を表す文字列(たとえば "2008/1/31")を代入値として使いたい場合は、Stringプロパティに代入します。

CellAddress

セルアドレスオブジェクト(com.sun.table.CellAddress)

Dim oCell As Object
Dim Sheet As Integer
Dim Column As Long
Dim Row As Long

oCell = ThisComponent.Sheets(0).getCellByPosition(0, 0)

Sheet  = oCell.CellAddress.Sheet
Column = oCell.CellAddress.Column
Row    = oCell.CellAddress.Row

String

Dim String As String

セルの文字列

メソッドの詳細

clearContents

clearContentsは、セルの内容をクリアするメソッドです。clearContentsは、次のオブジェクトで使用することができます。

シート・オブジェクトの場合、シートのすべてのセルの内容をクリアします。Rangeオブジェクトの場合、対象となる複数のセルの内容をクリアします。

SbxVOID clearContents(SbxLONG)

戻り値はありません。引数には、フラグをLong値で指定します。

フラグの一覧
フラグ 説明
1 VALUE 日付や時刻として書式設定されていない数値
2 DATETIME 日付や時刻として書式設定されている数値
4 STRING 文字列
8 ANNOTATION セルに付けられたコメント
16 FORMULA 計算式
32 HARDATTR セルに直接指定された書式
64 STYLES 間接的に指定された書式
128 OBJECT セルに配置された描画オブジェクト
256 EDITATTR セル内の一部のテキストに対してのみ指定された書式

一度に複数のフラグを指定することもできます。たとえば、セルの文字列とセルに直接指定された書式をクリアするには、4 + 32 で 36 を引数に指定します。

oSheet.clearContents(36)

セルのすべての内容をクリアするには、1 + 2 + 4 + 8 + 16 + 32 + 64 + 128 + 256 で 511 を引数に指定します。

oCell.clearContents(511)
使用例

セルの内容をクリアするOpenOffice.org Basicマクロの例を次に示します。

Dim oCell As Object

oCell = ThisComponent.Sheets.getByName("表1").getCellByPosition(0, 0)
oCell.clearContents(36)

ScCellRangeObj

OpenOffice/LibreOfficeマクロのScCellRangeObjオブジェクトは、Calcスプレッドシートにおけるセル範囲を表わすオブジェクトです。

プロパティの概要

ScCellRangeObjのプロパティ一覧を次に示す。

プロパティ 概要
SbxSTRING AbsoluteName
SbxBOOL AsianVerticalMode
SbxOBJECT BottomBorder
SbxLONG CellBackColor
SbxOBJECT CellProtection
SbxSTRING CellStyle
SbxLONG CharColor 文字の色
SbxBOOL CharContoured
SbxBOOL CharCrossedOut
SbxINTEGER CharEmphasis
SbxINTEGER CharFont
SbxINTEGER CharFontCharSet
SbxINTEGER CharFontCharSetAsian
SbxINTEGER CharFontCharSetComplex
SbxINTEGER CharFontFamily
SbxINTEGER CharFontFamilyAsian
SbxINTEGER CharFontFamilyComplex
SbxSTRING CharFontName
SbxSTRING CharFontNameAsian
SbxSTRING CharFontNameComplex
SbxINTEGER CharFontPitch
SbxINTEGER CharFontPitchAsian
SbxINTEGER CharFontPitchComplex
SbxSTRING CharFontStyleName
SbxSTRING CharFontStyleNameAsian
SbxSTRING CharFontStyleNameComplex
SbxSINGLE CharHeight
SbxSINGLE CharHeightAsian
SbxSINGLE CharHeightComplex
SbxOBJECT CharLocale
SbxOBJECT CharLocaleAsian
SbxOBJECT CharLocaleComplex
SbxLONG CharPosture
SbxLONG CharPostureAsian
SbxLONG CharPostureComplex
SbxINTEGER CharRelief
SbxBOOL CharShadowed
SbxINTEGER CharStrikeout
SbxINTEGER CharUnderline
SbxLONG CharUnderlineColor
SbxBOOL CharUnderlineHasColor
SbxSINGLE CharWeight
SbxSINGLE CharWeightAsian
SbxSINGLE CharWeightComplex
SbxBOOL CharWordMode
SbxBOOL ChartColumnAsLabel
SbxBOOL ChartRowAsLabel
SbxOBJECT ConditionalFormat
SbxOBJECT ConditionalFormatLocal
SbxOBJECT ConditionalFormatXML
SbxOBJECT DiagonalBLTR
SbxOBJECT DiagonalTLBR
SbxLONG HoriJustify
SbxBOOL IsCellBackgroundTransparent
SbxBOOL IsTextWrapped
SbxOBJECT LeftBorder
SbxLONG NumberFormat
SbxOBJECT NumberingRules
SbxLONG Orientation
SbxINTEGER ParaAdjust
SbxLONG ParaBottomMargin
SbxINTEGER ParaIndent
SbxBOOL ParaIsCharacterDistance
SbxBOOL ParaIsForbiddenRules
SbxBOOL ParaIsHangingPunctuation
SbxBOOL ParaIsHyphenation
SbxINTEGER ParaLastLineAdjust
SbxLONG ParaLeftMargin
SbxLONG ParaRightMargin
SbxLONG ParaTopMargin
SbxOBJECT Position
SbxOBJECT RightBorder
SbxLONG RotateAngle
SbxLONG RotateReference
SbxOBJECT ShadowFormat
SbxBOOL ShrinkToFit
SbxOBJECT Size
SbxOBJECT TableBorder
SbxOBJECT TopBorder
SbxOBJECT UserDefinedAttributes
SbxOBJECT Validation
SbxOBJECT ValidationLocal
SbxOBJECT ValidationXML
SbxLONG VertJustify
SbxINTEGER WritingMode
SbxOBJECT PropertySetInfo
SbxSTRING PropertyToDefault
SbxDOUBLE NotANumber
SbxARRAY Data
SbxARRAY RowDescriptions
SbxARRAY ColumnDescriptions
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxARRAY Types
SbxARRAY ImplementationId
SbxOBJECT RangeAddress
SbxOBJECT Spreadsheet
SbxSTRING ArrayFormula
SbxARRAY ArrayTokens
SbxARRAY DataArray
SbxARRAY FormulaArray
SbxBOOL IsMerged
SbxOBJECT Columns
SbxOBJECT Rows
SbxOBJECT CellFormatRanges
SbxOBJECT UniqueCellFormatRanges
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

メソッドの概要

ScCellRangeObjのメソッド一覧を次に示す。

メソッド 概要
SbxEMPTY queryInterface ( SbxOBJECT )
SbxOBJECT getPropertySetInfo ( void )
SbxVOID setPropertyValue ( SbxSTRING, SbxVARIANT )
SbxEMPTY getPropertyValue ( SbxSTRING )
SbxVOID addPropertyChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID removePropertyChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID addVetoableChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID removeVetoableChangeListener ( SbxSTRING, SbxOBJECT )
SbxOBJECT getPropertySetInfo ( void )
SbxVOID setPropertyValues ( SbxARRAY, SbxARRAY )
SbxARRAY getPropertyValues ( SbxARRAY )
SbxVOID addPropertiesChangeListener ( SbxARRAY, SbxOBJECT )
SbxVOID removePropertiesChangeListener ( SbxOBJECT )
SbxVOID firePropertiesChangeEvent ( SbxARRAY, SbxOBJECT )
SbxLONG getPropertyState ( SbxSTRING )
SbxARRAY getPropertyStates ( SbxARRAY )
SbxVOID setPropertyToDefault ( SbxSTRING )
SbxEMPTY getPropertyDefault ( SbxSTRING )
SbxDOUBLE computeFunction ( SbxLONG )
SbxVOID clearContents ( SbxLONG ) セル範囲の内容をクリアする
SbxVOID addChartDataChangeEventListener ( SbxOBJECT )
SbxVOID removeChartDataChangeEventListener ( SbxOBJECT )
SbxDOUBLE getNotANumber ( void )
SbxBOOL isNotANumber ( SbxDOUBLE )
SbxARRAY getData ( void )
SbxVOID setData ( SbxARRAY )
SbxARRAY getRowDescriptions ( void )
SbxVOID setRowDescriptions ( SbxARRAY )
SbxARRAY getColumnDescriptions ( void )
SbxVOID setColumnDescriptions ( SbxARRAY )
SbxVOID decrementIndent ( void )
SbxVOID incrementIndent ( void )
SbxOBJECT queryVisibleCells ( void )
SbxOBJECT queryEmptyCells ( void )
SbxOBJECT queryContentCells ( SbxINTEGER )
SbxOBJECT queryFormulaCells ( SbxLONG )
SbxOBJECT queryColumnDifferences ( SbxOBJECT )
SbxOBJECT queryRowDifferences ( SbxOBJECT )
SbxOBJECT queryIntersection ( SbxOBJECT )
SbxOBJECT queryDependents ( SbxBOOL )
SbxOBJECT queryPrecedents ( SbxBOOL )
SbxOBJECT createSearchDescriptor ( void )
SbxOBJECT findAll ( SbxOBJECT )
SbxOBJECT findFirst ( SbxOBJECT )
SbxOBJECT findNext ( SbxOBJECT, SbxOBJECT )
SbxOBJECT createReplaceDescriptor ( void )
SbxLONG replaceAll ( SbxOBJECT )
SbxVOID addModifyListener ( SbxOBJECT )
SbxVOID removeModifyListener ( SbxOBJECT )
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxINT64 getSomething ( SbxARRAY )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxOBJECT getRangeAddress ( void )
SbxOBJECT getCellByPosition ( SbxLONG, SbxLONG )
SbxOBJECT getCellRangeByPosition ( SbxLONG, SbxLONG, SbxLONG, SbxLONG )
SbxOBJECT getCellRangeByName ( SbxSTRING )
SbxOBJECT getSpreadsheet ( void )
SbxSTRING getArrayFormula ( void )
SbxVOID setArrayFormula ( SbxSTRING )
SbxARRAY getArrayTokens ( void )
SbxVOID setArrayTokens ( SbxARRAY )
SbxARRAY getDataArray ( void ) セル範囲の値を配列に読み込む
SbxVOID setDataArray ( SbxARRAY ) 配列の値をセル範囲に書き出す
SbxARRAY getFormulaArray ( void ) セル範囲の数式を配列に読み込む
SbxVOID setFormulaArray ( SbxARRAY ) 数式の配列をセル範囲に書き出す
SbxVOID setTableOperation ( SbxOBJECT, SbxLONG, SbxOBJECT, SbxOBJECT )
SbxVOID merge ( SbxBOOL )
SbxBOOL getIsMerged ( void )
SbxVOID fillSeries ( SbxLONG, SbxLONG, SbxLONG, SbxDOUBLE, SbxDOUBLE )
SbxVOID fillAuto ( SbxLONG, SbxLONG )
SbxVOID autoFormat ( SbxSTRING )
SbxARRAY createSortDescriptor ( void )
SbxVOID sort ( SbxARRAY )
SbxOBJECT createFilterDescriptor ( SbxBOOL )
SbxVOID filter ( SbxOBJECT )
SbxOBJECT createFilterDescriptorByObject ( SbxOBJECT )
SbxOBJECT createSubTotalDescriptor ( SbxBOOL )
SbxVOID applySubTotals ( SbxOBJECT, SbxBOOL )
SbxVOID removeSubTotals ( void )
SbxOBJECT getColumns ( void )
SbxOBJECT getRows ( void )
SbxARRAY createImportDescriptor ( SbxBOOL )
SbxVOID doImport ( SbxARRAY )
SbxOBJECT getCellFormatRanges ( void )
SbxOBJECT getUniqueCellFormatRanges ( void )

プロパティの詳細

CharColor

文字の色

文字の色を表す数値はRGB関数で求めることができる。

RGB( red , green , blue )

赤、緑、青の要素をそれぞれ0から255の値で指定する。

oRange.CharColor = RGB(127, 0, 255)

メソッドの詳細

clearContents

セル範囲(対象となる複数のセル)の内容をクリアする。

呼び出し形式
SbxVOID clearContents(SbxLONG)

OpenOffice.org Basic での呼び出し形式:

Sub clearContents( flag As Long)

戻り値

無し

引数

flag
クリアする内容を指定する数値
フラグの一覧
フラグ 説明
1 VALUE 日付や時刻として書式設定されていない数値
2 DATETIME 日付や時刻として書式設定されている数値
4 STRING 文字列
8 ANNOTATION セルに付けられたコメント
16 FORMULA 計算式
32 HARDATTR セルに直接指定された書式
64 STYLES 間接的に指定された書式
128 OBJECT セルに配置された描画オブジェクト
256 EDITATTR セル内の一部のテキストに対してのみ指定された書式

一度に複数のフラグを指定することもできます。たとえば、セルの文字列とセルに直接指定された書式をクリアするには、4 + 32 で 36 を引数に指定します。

oRange.clearContents(36)

セルのすべての内容をクリアするには、1 + 2 + 4 + 8 + 16 + 32 + 64 + 128 + 256 で 511 を引数に指定します。

oRange.clearContents(511)
使用例

複数セルの内容をクリアするOpenOffice.org Basicマクロの例を次に示します。

Dim oSheet As Object
Dim oRange As Object

oSheet = ThisComponent.Sheets.getByName("表1")
oRange = oSheet.getCellRangePosition(0, 0, 10, 5)
oRange.clearContents(36)

getDataArray

getDataArrayメソッドは、セル範囲内の値を配列に読み込む。

呼び出し形式
SbxARRAY getDataArray(void)

OpenOffice.org Basic での呼び出し形式:

Function getDataArray As Variant()
戻り値

指定されたセル範囲内の値が格納された配列

引数

無し

使用例
Dim Sheet As Object
Dim DataArray()
Dim RowDataArray()

Sheet = ThisComponent.Sheets(0)
DataArray() = Sheet.getCellRangeByPosition(0, 0, 1, 1).getDataArray()

RowDataArray() = DataArray(0)
' RowDataArray(0) = Sheet.getCellByPosition(0, 0).Value(1行1列目)
' RowDataArray(1) = Sheet.getCellByPosition(1, 0).Value(1行2列目)

RowDataArray() = DataArray(1)
' RowDataArray(0) = Sheet.getCellByPosition(0, 1).Value(2行1列目)
' RowDataArray(1) = Sheet.getCellByPosition(1, 1).Value(2行2列目)

setDataArray

setDataArrayメソッドは、配列に格納されたデータをセル範囲内に書き込む。

呼び出し形式
SbxVOID setDataArray(SbxARRAY)

OpenOffice.org Basic での呼び出し形式:

Sub setDataArray( data () As Variant)
戻り値

無し

引数
data
セル範囲内に書き込むデータを格納した配列
使用例
Dim Sheet As Object
Dim DataArray(1)

DataArray(0) = Array(1, 2)
DataArray(1) = Array(3, 4)

Sheet = ThisComponent.Sheets(0)
Sheet.getCellRangeByPosition(0, 0, 1, 1).setDataArray(DataArray)

getFormulaArray

getFormulaArrayメソッドは、セル範囲内の数式を配列に読み込む。

呼び出し形式
SbxARRAY getFormulaArray(void)

OpenOffice.org Basic での呼び出し形式:

Function getFormulaArray As Variant()
戻り値

指定されたセル範囲内の数式が格納された配列

引数

無し

使用例
Dim Sheet As Object
Dim DataArray()
Dim RowDataArray()

Sheet = ThisComponent.Sheets(0)
DataArray() = Sheet.getCellRangeByPosition(0, 0, 1, 1,).getFormulaArray()

RowDataArray() = DataArray(0)
' RowDataArray(0) = Sheet.getCellByPosition(0, 0).Formula(1行1列目)
' RowDataArray(1) = Sheet.getCellByPosition(1, 0).Formula(1行2列目)

RowDataArray() = DataArray(1)
' RowDataArray(0) = Sheet.getCellByPosition(0, 1).Formula(2行1列目)
' RowDataArray(1) = Sheet.getCellByPosition(1, 1).Formula(2行2列目)

setFormulaArray

setFormulaArrayメソッドは、配列に格納された数式をセル範囲内に書き込む。

呼び出し形式
SbxVOID setFormulaArray(SbxARRAY)

OpenOffice.org Basic での呼び出し形式:

Sub setFormulaArray( formula () As Variant)
戻り値

無し

引数
formula
セル範囲内に書き込む数式を格納した配列
使用例
Dim Sheet As Object
Dim DataArray(1)

DataArray(0) = Array("=Max(X1:X9)", "=Min(X1:X9)")
DataArray(1) = Array("=Max(Y1:Y9)", "=Min(Y1:Y9)")

Sheet = ThisComponent.Sheets(0)
Sheet.getCellRangeByPosition(0, 0, 1, 1,).setDataArray(DataArray)

ScChartsObj

ScChartsObjはOpenOffice/LibreOffice Basicマクロでチャート(グラフ)を表すオブジェクトです。

メソッド

ScChartsObjのメソッド一覧を次に示す。

プロパティ 概要
SbxEMPTY queryInterface ( SbxOBJECT )
SbxOBJECT getElementType ( void )
SbxBOOL hasElements ( void )
SbxEMPTY getByName ( SbxSTRING )
SbxARRAY getElementNames ( void )
SbxBOOL hasByName ( SbxSTRING ) チャートの有無を返す
SbxVOID addNewByName ( SbxSTRING, SbxOBJECT, SbxARRAY, SbxBOOL, SbxBOOL ) チャートを追加する
SbxVOID removeByName ( SbxSTRING ) チャートを削除する
SbxOBJECT createEnumeration ( void )
SbxLONG getCount ( void )
SbxEMPTY getByIndex ( SbxLONG )
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxOBJECT queryAdapter ( void )

hasByName

指定した名前のグラフ(チャート)が存在するか否かを判定する。

呼び出し形式
SbxBOOL hasByName(SbxSTRING)

OpenOffice.org Basicの呼び出し形式:

Function hasByName( name As String) As Boolean
戻り値

指定された名前のグラフ(チャート)が存在すればTrue、存在しなければFalseが返る。

使用例
Dim oCharts As Object

oCharts = ThisComponent.Sheets.getByName("表1").Charts

' グラフが無ければ追加する
If oCharts.hasByName("CandleChart") = False Then
  oCharts.addNewByName("CandleChart", Rect, RangeAddress(), True, True)
End If

addNewByName

新たにグラフ(チャート)を追加する。

呼び出し形式

SbxVOID addNewByName(SbxSTRING, SbxOBJECT, SbxARRAY, SbxBOOL, SbxBOOL)

OpenOffice.org Basicの呼び出し形式:

void addNewByName(String aName , com.sun.star.awt.Rectangle aRect , sequence<CellRangeAddress> aRanges , Boolean bRowHeaders , Boolean bColumnHeaders )
戻り値

無し

引数
aName
追加するグラフ(チャート)の名前
bRowHeaders
最初の行を項目名として使用する場合はTrue、使用しない場合はFalseを指定する。
bColumnHeaders
最初の列を項目名として使用する場合はTrue、使用しない場合はFalseを指定する。

removeByName

指定した名前のグラフ(チャート)を削除する。

呼び出し形式
SbxVOID removeByName(SbxSTRING)

OpenOffice.org Basicの呼び出し形式:

Sub removeByName( name As String)
戻り値

無し

name
削除するグラフ(チャート)の名前
使用例
Dim oCharts As Object

oCharts = ThisComponent.Sheets.getByName("表1").Charts

' グラフがあれば削除する
If oCharts.hasByName("CandleChart") = True Then
  oCharts.removeByName("CandleChart")
End If

ScTableSheetObj

ScTableSheetObjは、OpenOffice.org Calcテーブルシートを表すオブジェクトである。

プロパティの概要

ScTableSheetObj のプロパティ一覧を次に示す。

プロパティ 概要
SbxSTRING AbsoluteName
SbxBOOL AsianVerticalMode
SbxBOOL AutomaticPrintArea
SbxLONG BorderColor
SbxOBJECT BottomBorder
SbxLONG CellBackColor
SbxOBJECT CellProtection
SbxSTRING CellStyle
SbxLONG CharColor
SbxBOOL CharContoured
SbxBOOL CharCrossedOut
SbxINTEGER CharEmphasis
SbxINTEGER CharFont
SbxINTEGER CharFontCharSet
SbxINTEGER CharFontCharSetAsian
SbxINTEGER CharFontCharSetComplex
SbxINTEGER CharFontFamily
SbxINTEGER CharFontFamilyAsian
SbxINTEGER CharFontFamilyComplex
SbxSTRING CharFontName
SbxSTRING CharFontNameAsian
SbxSTRING CharFontNameComplex
SbxINTEGER CharFontPitch
SbxINTEGER CharFontPitchAsian
SbxINTEGER CharFontPitchComplex
SbxSTRING CharFontStyleName
SbxSTRING CharFontStyleNameAsian
SbxSTRING CharFontStyleNameComplex
SbxSINGLE CharHeight
SbxSINGLE CharHeightAsian
SbxSINGLE CharHeightComplex
SbxOBJECT CharLocale
SbxOBJECT CharLocaleAsian
SbxOBJECT CharLocaleComplex
SbxLONG CharPosture
SbxLONG CharPostureAsian
SbxLONG CharPostureComplex
SbxINTEGER CharRelief
SbxBOOL CharShadowed
SbxINTEGER CharStrikeout
SbxINTEGER CharUnderline
SbxLONG CharUnderlineColor
SbxBOOL CharUnderlineHasColor
SbxSINGLE CharWeight
SbxSINGLE CharWeightAsian
SbxSINGLE CharWeightComplex
SbxBOOL CharWordMode
SbxBOOL ChartColumnAsLabel
SbxBOOL ChartRowAsLabel
SbxOBJECT ConditionalFormat
SbxOBJECT ConditionalFormatLocal
SbxOBJECT ConditionalFormatXML
SbxBOOL CopyBack
SbxBOOL CopyFormulas
SbxBOOL CopyStyles
SbxOBJECT DiagonalBLTR
SbxOBJECT DiagonalTLBR
SbxLONG HoriJustify
SbxBOOL IsActive
SbxBOOL IsCellBackgroundTransparent
SbxBOOL IsTextWrapped
SbxBOOL IsVisible
SbxOBJECT LeftBorder
SbxOBJECT LinkDisplayBitmap
SbxSTRING LinkDisplayName
SbxLONG NumberFormat
SbxOBJECT NumberingRules
SbxLONG Orientation
SbxSTRING PageStyle
SbxINTEGER ParaAdjust
SbxLONG ParaBottomMargin
SbxINTEGER ParaIndent
SbxBOOL ParaIsCharacterDistance
SbxBOOL ParaIsForbiddenRules
SbxBOOL ParaIsHangingPunctuation
SbxBOOL ParaIsHyphenation
SbxINTEGER ParaLastLineAdjust
SbxLONG ParaLeftMargin
SbxLONG ParaRightMargin
SbxLONG ParaTopMargin
SbxOBJECT Position
SbxBOOL PrintBorder
SbxBOOL Protected
SbxOBJECT RightBorder
SbxLONG RotateAngle
SbxLONG RotateReference
SbxOBJECT ShadowFormat
SbxBOOL ShowBorder
SbxBOOL ShrinkToFit
SbxOBJECT Size
SbxOBJECT TableBorder
SbxINTEGER TableLayout
SbxOBJECT TopBorder
SbxOBJECT UserDefinedAttributes
SbxOBJECT Validation
SbxOBJECT ValidationLocal
SbxOBJECT ValidationXML
SbxLONG VertJustify
SbxINTEGER WritingMode
SbxOBJECT PropertySetInfo
SbxSTRING PropertyToDefault
SbxDOUBLE NotANumber
SbxARRAY Data
SbxARRAY RowDescriptions
SbxARRAY ColumnDescriptions
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxARRAY Types
SbxARRAY ImplementationId
SbxOBJECT RangeAddress
SbxOBJECT Spreadsheet
SbxSTRING ArrayFormula
SbxARRAY DataArray
SbxARRAY FormulaArray
SbxBOOL IsMerged
SbxOBJECT Columns
SbxOBJECT Rows
SbxOBJECT CellFormatRanges
SbxOBJECT UniqueCellFormatRanges
SbxSTRING Name
SbxARRAY ColumnPageBreaks
SbxARRAY RowPageBreaks
SbxOBJECT Charts
SbxOBJECT DataPilotTables
SbxOBJECT Scenarios
SbxOBJECT Annotations
SbxOBJECT DrawPage
SbxARRAY PrintAreas
SbxBOOL PrintTitleColumns
SbxOBJECT TitleColumns
SbxBOOL PrintTitleRows
SbxOBJECT TitleRows
SbxBOOL IsScenario
SbxSTRING ScenarioComment
SbxARRAY Ranges
SbxLONG LinkMode
SbxSTRING LinkUrl
SbxSTRING LinkSheetName
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

メソッドの概要

ScTableSheetObj のメソッド一覧を次に示す。

com.sun.star.comp.chart.Diagramのメソッド
メソッド 概要
SbxEMPTY queryInterface ( SbxOBJECT ) インタフェースの問い合わせ
SbxOBJECT getPropertySetInfo ( void )
SbxVOID setPropertyValue ( SbxSTRING, SbxVARIANT )
SbxEMPTY getPropertyValue ( SbxSTRING )
SbxVOID addPropertyChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID removePropertyChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID addVetoableChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID removeVetoableChangeListener ( SbxSTRING, SbxOBJECT )
SbxOBJECT getPropertySetInfo ( void )
SbxVOID setPropertyValues ( SbxARRAY, SbxARRAY )
SbxARRAY getPropertyValues ( SbxARRAY )
SbxVOID addPropertiesChangeListener ( SbxARRAY, SbxOBJECT )
SbxVOID removePropertiesChangeListener ( SbxOBJECT )
SbxVOID firePropertiesChangeEvent ( SbxARRAY, SbxOBJECT )
SbxLONG getPropertyState ( SbxSTRING )
SbxARRAY getPropertyStates ( SbxARRAY )
SbxVOID setPropertyToDefault ( SbxSTRING )
SbxEMPTY getPropertyDefault ( SbxSTRING )
SbxDOUBLE computeFunction ( SbxLONG )
SbxVOID clearContents ( SbxLONG ) セルの内容のクリア
SbxVOID addChartDataChangeEventListener ( SbxOBJECT )
SbxVOID removeChartDataChangeEventListener ( SbxOBJECT )
SbxDOUBLE getNotANumber ( void )
SbxBOOL isNotANumber ( SbxDOUBLE )
SbxARRAY getData ( void )
SbxVOID setData ( SbxARRAY )
SbxARRAY getRowDescriptions ( void )
SbxVOID setRowDescriptions ( SbxARRAY )
SbxARRAY getColumnDescriptions ( void )
SbxVOID setColumnDescriptions ( SbxARRAY )
SbxVOID decrementIndent ( void )
SbxVOID incrementIndent ( void )
SbxOBJECT queryVisibleCells ( void )
SbxOBJECT queryEmptyCells ( void )
SbxOBJECT queryContentCells ( SbxINTEGER )
SbxOBJECT queryFormulaCells ( SbxLONG )
SbxOBJECT queryColumnDifferences ( SbxOBJECT )
SbxOBJECT queryRowDifferences ( SbxOBJECT )
SbxOBJECT queryIntersection ( SbxOBJECT )
SbxOBJECT queryDependents ( SbxBOOL )
SbxOBJECT queryPrecedents ( SbxBOOL )
SbxOBJECT createSearchDescriptor ( void )
SbxOBJECT findAll ( SbxOBJECT )
SbxOBJECT findFirst ( SbxOBJECT )
SbxOBJECT findNext ( SbxOBJECT, SbxOBJECT )
SbxOBJECT createReplaceDescriptor ( void )
SbxLONG replaceAll ( SbxOBJECT )
SbxVOID addModifyListener ( SbxOBJECT )
SbxVOID removeModifyListener ( SbxOBJECT )
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxINT64 getSomething ( SbxARRAY )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxOBJECT getRangeAddress ( void )
SbxOBJECT getCellByPosition ( SbxLONG, SbxLONG )
SbxOBJECT getCellRangeByPosition ( SbxLONG, SbxLONG, SbxLONG, SbxLONG )
SbxOBJECT getCellRangeByName ( SbxSTRING )
SbxOBJECT getSpreadsheet ( void )
SbxSTRING getArrayFormula ( void )
SbxVOID setArrayFormula ( SbxSTRING )
SbxARRAY getDataArray ( void )
SbxVOID setDataArray ( SbxARRAY )
SbxARRAY getFormulaArray ( void )
SbxVOID setFormulaArray ( SbxARRAY )
SbxVOID setTableOperation ( SbxOBJECT, SbxLONG, SbxOBJECT, SbxOBJECT )
SbxVOID merge ( SbxBOOL )
SbxBOOL getIsMerged ( void )
SbxVOID fillSeries ( SbxLONG, SbxLONG, SbxLONG, SbxDOUBLE, SbxDOUBLE )
SbxVOID fillAuto ( SbxLONG, SbxLONG )
SbxVOID autoFormat ( SbxSTRING )
SbxARRAY createSortDescriptor ( void )
SbxVOID sort ( SbxARRAY )
SbxOBJECT createFilterDescriptor ( SbxBOOL )
SbxVOID filter ( SbxOBJECT )
SbxOBJECT createFilterDescriptorByObject ( SbxOBJECT )
SbxOBJECT createSubTotalDescriptor ( SbxBOOL )
SbxVOID applySubTotals ( SbxOBJECT, SbxBOOL )
SbxVOID removeSubTotals ( void )
SbxOBJECT getColumns ( void )
SbxOBJECT getRows ( void )
SbxARRAY createImportDescriptor ( SbxBOOL )
SbxVOID doImport ( SbxARRAY )
SbxOBJECT getCellFormatRanges ( void )
SbxOBJECT getUniqueCellFormatRanges ( void )
SbxOBJECT createCursor ( void )
SbxOBJECT createCursorByRange ( SbxOBJECT )
SbxSTRING getName ( void )
SbxVOID setName ( SbxSTRING )
SbxARRAY getColumnPageBreaks ( void )
SbxARRAY getRowPageBreaks ( void )
SbxVOID removeAllManualPageBreaks ( void )
SbxVOID insertCells ( SbxOBJECT, SbxLONG )
SbxVOID removeRange ( SbxOBJECT, SbxLONG )
SbxVOID moveRange ( SbxOBJECT, SbxOBJECT )
SbxVOID copyRange ( SbxOBJECT, SbxOBJECT )
SbxOBJECT getCharts ( void )
SbxOBJECT getDataPilotTables ( void )
SbxOBJECT getScenarios ( void )
SbxOBJECT getAnnotations ( void )
SbxOBJECT getDrawPage ( void )
SbxARRAY getPrintAreas ( void )
SbxVOID setPrintAreas ( SbxARRAY )
SbxBOOL getPrintTitleColumns ( void )
SbxVOID setPrintTitleColumns ( SbxBOOL )
SbxOBJECT getTitleColumns ( void )
SbxVOID setTitleColumns ( SbxOBJECT )
SbxBOOL getPrintTitleRows ( void )
SbxVOID setPrintTitleRows ( SbxBOOL )
SbxOBJECT getTitleRows ( void )
SbxVOID setTitleRows ( SbxOBJECT )
SbxBOOL hideDependents ( SbxOBJECT )
SbxBOOL hidePrecedents ( SbxOBJECT )
SbxBOOL showDependents ( SbxOBJECT )
SbxBOOL showPrecedents ( SbxOBJECT )
SbxBOOL showErrors ( SbxOBJECT )
SbxBOOL showInvalid ( void )
SbxVOID clearArrows ( void )
SbxVOID group ( SbxOBJECT, SbxLONG )
SbxVOID ungroup ( SbxOBJECT, SbxLONG )
SbxVOID autoOutline ( SbxOBJECT )
SbxVOID clearOutline ( void )
SbxVOID hideDetail ( SbxOBJECT )
SbxVOID showDetail ( SbxOBJECT )
SbxVOID showLevel ( SbxINTEGER, SbxLONG )
SbxVOID protect ( SbxSTRING )
SbxVOID unprotect ( SbxSTRING )
SbxBOOL isProtected ( void )
SbxBOOL getIsScenario ( void )
SbxSTRING getScenarioComment ( void )
SbxVOID setScenarioComment ( SbxSTRING )
SbxVOID addRanges ( SbxARRAY )
SbxVOID apply ( void )
SbxARRAY getRanges ( void )
SbxLONG getLinkMode ( void )
SbxVOID setLinkMode ( SbxLONG )
SbxSTRING getLinkUrl ( void )
SbxVOID setLinkUrl ( SbxSTRING )
SbxSTRING getLinkSheetName ( void )
SbxVOID setLinkSheetName ( SbxSTRING )
SbxVOID link ( SbxSTRING, SbxSTRING, SbxSTRING, SbxSTRING, SbxLONG )

プロパティの詳細

RangeAddress

com.sun.star.table.CellRangeAddress参照

メソッドの詳細

clearContents

表(テーブルシート)のすべてのセルの内容をクリアする。

呼び出し形式
SbxVOID clearContenets(SbxLONG)

OpenOffice.org Basicの呼び出し形式:

Sub clearContenets( flag As Long)
戻り値

無し

引数
flag
セルの属性のうち何をクリアするか指定するフラグ
フラグ 説明
1 VALUE 日付や時刻として書式設定されていない数値
2 DATETIME 日付や時刻として書式設定されている数値
4 STRING 文字列
8 ANNOTATION セルに付けられたコメント
16 FORMULA 計算式
32 HARDATTR セルに直接指定された書式
64 STYLES 間接的に指定された書式
128 OBJECT セルに配置された描画オブジェクト
256 EDITATTR セル内の一部のテキストに対してのみ指定された書式

一度に複数のフラグを指定することもできます。たとえば、セルの文字列とセルに直接指定された書式をクリアするには、4 + 32 で 36 を引数に指定します。

oSheet.clearContents(36)

セルのすべての内容をクリアするには、1 + 2 + 4 + 8 + 16 + 32 + 64 + 128 + 256 で 511 を引数に指定します。

oCell.clearContents(511)
使用例

シートのすべてのセルの内容をクリアするOpenOffice.org Basicマクロの例を次に示します。

Dim oSheet As Object

oSheet = ThisComponent.Sheets.getByName("表1")
oSheet.clearContents(36)

getCellByPosition

Function getCellByPosition( column As Long, row As Long) As Object

列番号と行番号で指定したセルのオブジェクトへの参照を返す。

戻り値

セルを表すオブジェクト(ScCellObj)への参照

引数
column
列番号(0始まり)
row
行番号(0始まり)

getCellRangeByPosition

Function getCellRangeByPosition( StartColumn As Long, StartRow As Long, EndColumn As Long, EndRow As Long) As Object
戻り値

セル範囲を表すオブジェクト(ScCellRangeObj)への参照

引数
StartColumn
列番号(0始まり)
StartRow
行番号(0始まり)
EndColumn
列番号(0始まり)
EndRow
行番号(0始まり)

ScTableSheetsObj

ScTableSheetsObjは、OpenOffice.org Calc テーブルシートの集合を表すオブジェクトである。

プロパティの概要

ScTableSheetsObj のプロパティ一覧を次に示す。

プロパティ 概要
SbxOBJECT ElementType
SbxARRAY ElementNames
SbxLONG Count
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxARRAY Types
SbxARRAY ImplementationId
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

メソッドの概要

ScTableSheetsObj のメソッド一覧を次に示す。

メソッド 概要
SbxEMPTY queryInterface ( SbxOBJECT )
SbxOBJECT getElementType ( void )
SbxBOOL hasElements ( void )
SbxEMPTY getByName ( SbxSTRING ) テーブルシートオブジェクトへの参照を返す(名前で指定)
SbxARRAY getElementNames ( void )
SbxBOOL hasByName ( SbxSTRING ) テーブルシートが存在するか否かを返す
SbxVOID replaceByName ( SbxSTRING, SbxVARIANT )
SbxVOID insertByName ( SbxSTRING, SbxVARIANT )
SbxVOID removeByName ( SbxSTRING ) テーブルシートを削除する
SbxVOID insertNewByName ( SbxSTRING, SbxINTEGER ) 新たにテーブルシートを挿入する
SbxVOID moveByName ( SbxSTRING, SbxINTEGER )
SbxVOID copyByName ( SbxSTRING, SbxSTRING, SbxINTEGER )
SbxOBJECT getCellByPosition ( SbxLONG, SbxLONG, SbxLONG )
SbxOBJECT getCellRangeByPosition ( SbxLONG, SbxLONG, SbxLONG, SbxLONG, SbxLONG )
SbxARRAY getCellRangesByName ( SbxSTRING )
SbxOBJECT createEnumeration ( void )
SbxLONG getCount ( void ) テーブルシートの数を返す
SbxEMPTY getByIndex ( SbxLONG ) テーブルシートオブジェクトへの参照を返す(番号で指定)
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxOBJECT queryAdapter ( void )

メソッドの詳細

getByIndex

getByIndexメソッドは、指定したインデックス番号の表(シート)オブジェクトを返す。

呼び出し形式
SbxEMPTY getByIndex(SbxLONG)

OpenOffice.org Basic での呼び出し形式:

Function getByIndex( index As Long) As Object
戻り値

表(シート)オブジェクトを返す。

引数
index
オブジェクトを取得する表(シート)のインデックス番号

表(シート)には左から順番に0から始まるインデックス番号が付けられている。

使用例
Dim oSheet As Object
oSheet = ThisComponent.Sheets.getByIndex(0)

getByName

getByNameメソッドは、指定した名前の表(シート)オブジェクトを返す。

呼び出し形式
SbxEMPTY getByName(SbxSTRING)

OpenOffice.org Basic での呼び出し形式:

Function getByName( name As String) As Object
戻り値

表(シート)オブジェクトを返す。

引数
name
オブジェクトを取得する表(シート)の名前
使用例
Dim oSheet As Object

oSheet = ThisComponent.Sheets.getByName("表1")

getCount

ggetCountメソッドは、ドキュメントに含まれる表(シート)の数を返す。

呼び出し形式
SbxLONG getCount(void)

OpenOffice.org Basic での呼び出し形式:

Function getCount As Long
戻り値

ドキュメントに含まれる表(シート)の数を返す。

引数

無し

使用例
Dim count As Long

count = ThisComponent.Sheets.getCount

hasByName

hasByNameメソッドは、指定した名前の表(シート)が存在するか否かを判定する。

呼び出し形式
SbxBOOL hasByName(SbxSTRING)

OpenOffice.org Basic での呼び出し形式:

Function hasByName( name As String) As Boolean
戻り値

指定された名前の表(シート)が存在すればTrue、存在しなれけばFalseを返す。

引数
name
存在の有無を確認する表(シート)の名前
使用例
Dim oSheet As Object

If ThisComponent.Sheets.hasByName("表1") = True Then
  oSheet = ThisComponent.Sheets.getByName("表1")
End If

insertNewByName

insertNewByNameメソッドは、ドキュメントに新しい表(シート)を挿入する。

呼び出し形式
SbxVOID insertNewByName(SbxSTRING, SbxINTEGER)

OpenOffice.org Basic での呼び出し形式:

Sub insertNewByName( name As String, index As Integer)
戻り値

無し

引数
name
ドキュメントに挿入する新しい表(シート)の名前
index
ドキュメントに挿入する新しい表(シート)のインデックス番号

表(シート)には左から順番に0から始まるインデックス番号が付けられている。

使用例
Dim index As Integer

index = ThisComponent.Sheets.getCount
If ThisComponent.Sheets.hasByName("新しい表") = False Then
  ThisComponent.Sheets.insertNewByName("新しい表", index)
End If

removeByName

removeByNameメソッドは、指定した名前の表(テーブルシート)を削除する。

呼び出し形式
SbxVOID removeByName(SbxSTRING)

OpenOffice.org Basic での呼び出し形式:

Sub removeByName( name As String)
戻り値

無し

引数
name
削除する表(テーブルシート)の名前
使用例
If ThisComponent.Sheets.hasByName("表1") = True Then
  ThisComponent.Sheets.removeByName("表1")
End If

com.sun.star.chart.chartAxis

OpenOffice.org Calcのグラフ (Chart.Diagram) では、X軸およびY軸、Z軸、第2X軸、第2Y軸は軸オブジェクト(com.sun.star.chart.chartAxis)で表されています。

プロパティの概要

軸オブジェクトのプロパティを次に示します。

名前 種類 意味
Max Double 軸の最大値
Min Double 軸の最小値
Origin Double 軸の原点
StepMain Double 軸主目盛線の間隔
StepHelp Double 軸補助盛線の間隔
AutoMax Boolean 最大値の自動判定
AutoMin Boolean 最小値の自動判定
AutoOrigin Boolean 原点の自動判定
AutoStepMain Boolean 主目盛線の間隔の自動判定
AutoStepHelp Boolean 補助盛線の間隔の自動判定
NumberFormat Boolean 数の書式

軸の最大値は、AutoMaxプロパティがTrueであれば自動的に決まります。マクロで最大値を指定する場合は、AutoMaxプロパティにFalseを設定して、Maxプロパティに最大値を設定します。AutoMaxプロパティのデフォルト値はTrueです。

軸の最小値は、AutoMinプロパティがTrueであれば自動的に決まります。マクロで最小値を指定する場合は、AutoMinプロパティにFalseを設定して、Minプロパティに最小値を設定します。AutoMinプロパティのデフォルト値はTrueです。

プロパティの詳細

NumberFormat

Dim NumberFormat As Long

数の書式

セルに数値を表示する際、いろいろな書式で表示することができます。たとえば、千単位で区切ったり、小数点以下の桁数を指定したり、先頭の0を表示するか否かなどを指定することができます。数値の書式を指定するには、セル・オブジェクトやRangeオブジェクトのNumberFormatプロパティを設定します。

NumberFormatプロパティに設定するのは、Long型の数値です。この値と書式との関係を次に示します。

書式 書式コード
0 Standard Standard
1 -1234 0
2 -1234.12 0.00
3 -1,234 #,##0
4 -1,234.12 #,##0.00
5 -1,234.12 #,###.00
10 -13% 0%
11 -12.95% 0.00%
36 1999/12/31 YYYY/MM/DD
37 99/12/31 YY/MM/DD
101 -\1,234 [$¥-411]#,##0;-[$¥-411]#,##0
102 -\1,234.00 [$¥-411]#,##0.00;-[$¥-411]#,##0.00

セルの書式設定をする例を次に示します。この例では、数値を千単位で区切り、小数点以下の桁は表示しないように設定しています。

Dim oCell As Object

oCell = ThisComponent.Sheets(0).getCellByPosition(0, 0)
oCell.NumberFormat = 3
oCell.Value = 1234.12

セル・オブジェクトではなく、RangeオブジェクトのNumberFormatプロパティを設定すれば、まとめて複数のセルの書式を設定することができます。

com.sun.star.chart.DataSeries

com.sun.star.chart.DataSeriesは、OpenOffice/LibreOfficeにおけるグラフのデータ系列を表わすオブジェクトです。

プロパティ

DataSeriesのプロパティ
名前 種類 意味
LineColor Long 線の色
LineDash com.sun.star.drawing.LineDash 点線・破線
LineWidth Long 線の幅
LineStyle Long 線のスタイル

LineColor

線の色を表すLong値

Dim chart As Object
Dim diagram As Object
Dim dataRowProperty As Object

chart = ThisComponent.Sheets.getByName("表1").Charts.getByName("グラフ1")
diagram = chart.embeddedObject.Diagram
dataRowProperty = diagram.getDataRowProperties(1)

dataRowProperty.LineColor = RGB(255, 0, 0)

LineDash

点線・破線を表すオブジェクト(com.sun.star.drawing.LineDash)

LineWidth

線の幅を表すLong値

Dim chart As Object
Dim diagram As Object
Dim dataRowProperty As Object

chart = ThisComponent.Sheets.getByName("表1").Charts.getByName("グラフ1")
diagram = chart.embeddedObject.Diagram
dataRowProperty = diagram.getDataRowProperties(1)

dataRowProperty.LineWidth = 40

LineStyle

線のスタイルを表すLong値。以下の列挙値のうちいずれかの値。

LineStyle
列挙値 意味
com.sun.star.drawing.LineStyle.NONE 線なし
com.sun.star.drawing.LineStyle.SOLID 実線
com.sun.star.drawing.LineStyle.DASH 点線・破線
Dim chart As Object
Dim diagram As Object
Dim dataRowProperty As Object

chart = ThisComponent.Sheets.getByName("表1").Charts.getByName("グラフ1")
diagram = chart.embeddedObject.Diagram
dataRowProperty = diagram.getDataRowProperties(1)

dataRowProperty.LineStyle = com.sun.star.drawing.LineStyle.SOLID

com.sun.star.awt.Point

com.sun.star.awt.Pointは位置(XとY)を表すオブジェクトである。

プロパティの概要

名前 種類 意味
X Long 水平方向の位置
Y Long 垂直方向の位置

メソッドの概要

無し

com.sun.star.awt.Rectangle

com.sun.star.awt.Rectangleオブジェクトはグラフを描画する矩形領域を表します。

プロパティの概要

Rectオブジェクトのプロパティ
名前 種類 意味
X Long 左上の位置(X軸)
Y Long 左上の位置(Y軸)
Width Long
Height Long 高さ

com.sun.star.awt.Size

com.sun.star.awt.Sizeはサイズ(幅と高さ)を表すオブジェクトである。

プロパティの概要

名前 種類 意味
Width Long
Height Long 高さ

メソッドの概要

無し

com.sun.star.chart.LineDash

com.sun.star.chart.LineDash は、点線や破線を表すオブジェクトである。

プロパティの概要

com.sun.star.chart.LineDashのプロパティ
名前 種類 意味
Style Long 線のスタイル
Dots Integer
DotLen Long
Dashes Integer
DashLen Long
Distance Long

プロパティの詳細

Style

線のスタイルを表すLong値。以下の列挙値のうちいずれかの値。

列挙値 意味
com.sun.star.drawing.DashStyle.RECT 破線
com.sun.star.drawing.DashStyle.ROUND 点線
com.sun.star.drawing.DashStyle.RECTRELATIVE 破線
com.sun.star.drawing.DashStyle.ROUNDRELATIVE 点線

com.sun.star.comp.chart.ChartLine

属性

com.sun.star.comp.chart.ChartLineの属性一覧を次に示す。

ChartLineの属性
属性 意味
SbxOBJECT/void ChartUserDefinedAttributes
SbxLONG LineColor 線の色
SbxOBJECT/void LineDash 点線・破線に関する情報を収めたオブジェクト
SbxSTRING/void LineDashName
SbxLONG LineJoint
SbxLONG LineStyle 線のスタイル
SbxINTEGER LineTransparence
SbxLONG LineWidth 線の幅
SbxOBJECT/void ParaUserDefinedAttributes
SbxOBJECT/void TextUserDefinedAttributes
SbxOBJECT/void UserDefinedAttributes
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxOBJECT PropertySetInfo
SbxSTRING PropertyToDefault
SbxARRAY PropertiesToDefault
SbxARRAY Types
SbxARRAY ImplementationId
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

LineDash

点線・破線に関する情報を収めたオブジェクト(com.sun.star.drawing.LineDashサービスをサポート)。

メソッド

com.sun.star.comp.chart.ChartLineのメソッド一覧を次に示す。

ChartLineのメソッド
メソッド 意味
SbxEMPTY queryInterface ( SbxOBJECT )
SbxVOID dispose ( void )
SbxVOID addEventListener ( SbxOBJECT )
SbxVOID removeEventListener ( SbxOBJECT )
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxOBJECT getPropertySetInfo ( void )
SbxVOID setPropertyValue ( SbxSTRING, SbxVARIANT )
SbxEMPTY getPropertyValue ( SbxSTRING )
SbxVOID addPropertyChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID removePropertyChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID addVetoableChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID removeVetoableChangeListener ( SbxSTRING, SbxOBJECT )
SbxOBJECT getPropertySetInfo ( void )
SbxVOID setPropertyValues ( SbxARRAY, SbxARRAY )
SbxARRAY getPropertyValues ( SbxARRAY )
SbxVOID addPropertiesChangeListener ( SbxARRAY, SbxOBJECT )
SbxVOID removePropertiesChangeListener ( SbxOBJECT )
SbxVOID firePropertiesChangeEvent ( SbxARRAY, SbxOBJECT )
SbxLONG getPropertyState ( SbxSTRING )
SbxARRAY getPropertyStates ( SbxARRAY )
SbxVOID setPropertyToDefault ( SbxSTRING )
SbxEMPTY getPropertyDefault ( SbxSTRING )
SbxARRAY getPropertyStates ( SbxARRAY )
SbxVOID setAllPropertiesToDefault ( void )
SbxVOID setPropertiesToDefault ( SbxARRAY )
SbxARRAY getPropertyDefaults ( SbxARRAY )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxOBJECT queryAdapter ( void )

com.sun.star.comp.chart.Diagram

com.sun.star.comp.chart.Diagramはダイアグラムを表すオブジェクトである。ダイアグラムとはグラフ(チャート)全体の領域のうち、タイトルや凡例などを除いた、中心部分に位置するグラフ領域(軸を含む)である。

属性

Diagramの属性
属性 概要
SbxARRAY/void AttributedDataPoints
SbxOBJECT/void ChartUserDefinedAttributes
SbxDOUBLE ConstantErrorHigh
SbxDOUBLE ConstantErrorLow
SbxOBJECT/void D3DCameraGeometry
SbxLONG/void D3DSceneAmbientColor
SbxLONG/void D3DSceneDistance
SbxLONG/void D3DSceneFocalLength
SbxLONG/void D3DSceneLightColor1
SbxLONG/void D3DSceneLightColor2
SbxLONG/void D3DSceneLightColor3
SbxLONG/void D3DSceneLightColor4
SbxLONG/void D3DSceneLightColor5
SbxLONG/void D3DSceneLightColor6
SbxLONG/void D3DSceneLightColor7
SbxLONG/void D3DSceneLightColor8
SbxOBJECT/void D3DSceneLightDirection1
SbxOBJECT/void D3DSceneLightDirection2
SbxOBJECT/void D3DSceneLightDirection3
SbxOBJECT/void D3DSceneLightDirection4
SbxOBJECT/void D3DSceneLightDirection5
SbxOBJECT/void D3DSceneLightDirection6
SbxOBJECT/void D3DSceneLightDirection7
SbxOBJECT/void D3DSceneLightDirection8
SbxBOOL/void D3DSceneLightOn1
SbxBOOL/void D3DSceneLightOn2
SbxBOOL/void D3DSceneLightOn3
SbxBOOL/void D3DSceneLightOn4
SbxBOOL/void D3DSceneLightOn5
SbxBOOL/void D3DSceneLightOn6
SbxBOOL/void D3DSceneLightOn7
SbxBOOL/void D3DSceneLightOn8
SbxLONG/void D3DScenePerspective
SbxLONG/void D3DSceneShadeMode
SbxLONG/void D3DSceneShadowSlant
SbxBOOL/void D3DSceneTwoSidedLighting
SbxOBJECT/void D3DTransformMatrix
SbxLONG DataCaption
SbxOBJECT/void DataErrorProperties
SbxOBJECT/void DataMeanValueProperties
SbxOBJECT/void DataRegressionProperties
SbxLONG DataRowSource
SbxBOOL Deep
SbxBOOL Dim3D 3D表示をする指定
SbxSTRING ErrorBarRangeNegative
SbxSTRING ErrorBarRangePositive
SbxLONG ErrorBarStyle
SbxLONG ErrorCategory
SbxLONG ErrorIndicator
SbxDOUBLE ErrorMargin
SbxBOOL FillBackground
SbxBOOL FillBitmapLogicalSize
SbxLONG FillBitmapMode
SbxSTRING/void FillBitmapName
SbxINTEGER FillBitmapOffsetX
SbxINTEGER FillBitmapOffsetY
SbxINTEGER FillBitmapPositionOffsetX
SbxINTEGER FillBitmapPositionOffsetY
SbxLONG FillBitmapRectanglePoint
SbxLONG FillBitmapSizeX
SbxLONG FillBitmapSizeY
SbxLONG/void FillColor
SbxSTRING/void FillGradientName
SbxINTEGER/void FillGradientStepCount
SbxSTRING/void FillHatchName
SbxLONG FillStyle
SbxINTEGER FillTransparence
SbxSTRING/void FillTransparenceGradientName
SbxBOOL GroupBarsPerAxis
SbxBOOL HasSecondaryXAxis X軸の第2数値軸を表示する指定
SbxBOOL HasSecondaryXAxisDescription X軸の第2数値軸のラベルを表示する指定
SbxBOOL HasSecondaryXAxisTitle
SbxBOOL HasSecondaryYAxis Y軸の第2数値軸を表示する指定
SbxBOOL HasSecondaryYAxisDescription Y軸の第2数値軸のラベルを表示する指定
SbxBOOL HasSecondaryYAxisTitle
SbxBOOL HasXAxis X軸を表示する指定
SbxBOOL HasXAxisDescription X軸のラベルを表示する指定
SbxBOOL HasXAxisGrid X軸の主目盛線を表示する指定
SbxBOOL HasXAxisHelpGrid X軸の補助目盛線を表示する指定
SbxBOOL HasXAxisTitle X軸のタイトルを表示する指定
SbxBOOL HasYAxis Y軸を表示する指定
SbxBOOL HasYAxisDescription Y軸のラベルを表示する指定
SbxBOOL HasYAxisGrid Y軸の主目盛線を表示する指定
SbxBOOL HasYAxisHelpGrid Y軸の補助目盛線を表示する指定
SbxBOOL HasYAxisTitle Y軸のタイトルを表示する指定
SbxBOOL HasZAxis Z軸を表示する指定
SbxBOOL HasZAxisDescription Z軸のラベルを表示する指定
SbxBOOL HasZAxisGrid Z軸の主目盛線を表示する指定
SbxBOOL HasZAxisHelpGrid Z軸の補助目盛線を表示する指定
SbxBOOL HasZAxisTitle Z軸のタイトルを表示する指定
SbxLONG LineColor 線の色
SbxOBJECT/void LineDash 点線・破線に関する情報を収めたオブジェクト
SbxSTRING/void LineDashName
SbxLONG LineJoint
SbxLONG LineStyle 線のスタイル
SbxINTEGER LineTransparence
SbxLONG LineWidth 線の幅
SbxBOOL Lines
SbxBOOL MeanValue
SbxLONG NumberOfLines
SbxOBJECT/void ParaUserDefinedAttributes
SbxBOOL Percent 個々の構成比をパーセント表示する指定
SbxDOUBLE PercentageError
SbxLONG/void Perspective
SbxLONG RegressionCurves
SbxBOOL RightAngledAxes
SbxLONG/void RotationHorizontal
SbxLONG/void RotationVertical
SbxLONG SolidType
SbxBOOL SortByXValues
SbxLONG/void SplineOrder
SbxLONG/void SplineResolution
SbxLONG/void SplineType
SbxBOOL Stacked 積み上げグラフによる表示の指定
SbxBOOL StackedBarsConnected
SbxLONG StartingAngle
SbxSTRING SymbolBitmapURL
SbxOBJECT SymbolSize
SbxLONG SymbolType
SbxOBJECT/void TextUserDefinedAttributes
SbxBOOL/void UpDown 株価チャートの始値を表示する指定
SbxOBJECT/void UserDefinedAttributes
SbxBOOL Vertical
SbxBOOL/void Volume 株価チャートの出来高を表示する指定
SbxSTRING ShapeType
SbxOBJECT Position 開始位置(左上の位置)
SbxOBJECT Size サイズ(幅と高さ)
SbxSTRING DiagramType
SbxOBJECT ZAxisTitle Z軸のタイトルに関する情報を収めたオブジェクト
SbxOBJECT ZAxis Z軸に関する情報を収めたオブジェクト
SbxOBJECT ZMainGrid Z軸の主目盛線に関する情報を収めたオブジェクト
SbxOBJECT ZHelpGrid Z軸の補助目盛線に関する情報を収めたオブジェクト
SbxOBJECT XAxisTitle X軸のタイトルに関する情報を収めたオブジェクト
SbxOBJECT XAxis X軸に関する情報を収めたオブジェクト
SbxOBJECT XMainGrid X軸の主目盛線に関する情報を収めたオブジェクト
SbxOBJECT XHelpGrid X軸の補助目盛線に関する情報を収めたオブジェクト
SbxOBJECT SecondaryXAxis X軸の第2数値軸に関する情報を収めたオブジェクト
SbxOBJECT YAxisTitle Y軸のタイトルに関する情報を収めたオブジェクト
SbxOBJECT YAxis Y軸に関する情報を収めたオブジェクト
SbxOBJECT YMainGrid Y軸の主目盛線に関する情報を収めたオブジェクト
SbxOBJECT YHelpGrid Y軸の補助目盛線に関する情報を収めたオブジェクト
SbxOBJECT SecondaryYAxis Y軸の第2数値軸に関する情報を収めたオブジェクト
SbxOBJECT UpBar 株価チャートの陽線に関する情報を収めたオブジェクト
SbxOBJECT DownBar 株価チャートの陰線に関する情報を収めたオブジェクト
SbxOBJECT MinMaxLine 株価チャートのヒゲに関する情報を収めたオブジェクト
SbxOBJECT Wall グラフの壁面
SbxOBJECT Floor グラフの床面
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxOBJECT Diagram
SbxOBJECT SecondXAxisTitle
SbxOBJECT SecondYAxisTitle
SbxARRAY Types
SbxARRAY ImplementationId
SbxOBJECT PropertySetInfo
SbxSTRING PropertyToDefault
SbxARRAY PropertiesToDefault
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

メソッド

com.sun.star.comp.chart.Diagramのメソッド
メソッド 概要
SbxEMPTY queryInterface ( SbxOBJECT ) インタフェースの問い合わせ
SbxSTRING getShapeType ( void )
SbxOBJECT getPosition ( void )
SbxVOID setPosition ( SbxOBJECT )
SbxOBJECT getSize ( void )
SbxVOID setSize ( SbxOBJECT )
SbxSTRING getDiagramType ( void )
SbxOBJECT getDataRowProperties ( SbxLONG )
SbxOBJECT getDataPointProperties ( SbxLONG, SbxLONG )
SbxOBJECT getZAxisTitle ( void )
SbxOBJECT getZMainGrid ( void ) Z軸の主目盛線に関する情報を収めたオブジェクトに対する参照を取得
SbxOBJECT getZHelpGrid ( void ) Z軸の補助目盛線に関する情報を収めたオブジェクトに対する参照を取得
SbxOBJECT getZAxis ( void ) Z軸に関する情報を収めたオブジェクトに対する参照を取得
SbxOBJECT getXAxisTitle ( void )
SbxOBJECT getXAxis ( void ) X軸に関する情報を収めたオブジェクトに対する参照を取得
SbxOBJECT getXMainGrid ( void ) X軸の主目盛線に関する情報を収めたオブジェクトに対する参照を取得
SbxOBJECT getXHelpGrid ( void ) X軸の補助目盛線に関する情報を収めたオブジェクトに対する参照を取得
SbxOBJECT getSecondaryXAxis ( void ) X軸の第2数値軸に関する情報を収めたオブジェクトに対する参照を取得
SbxOBJECT getYAxisTitle ( void )
SbxOBJECT getYAxis ( void ) Y軸に関する情報を収めたオブジェクトに対する参照を取得
SbxOBJECT getYHelpGrid ( void ) Y軸の補助目盛線に関する情報を収めたオブジェクトに対する参照を取得
SbxOBJECT getYMainGrid ( void ) Y軸の主目盛線に関する情報を収めたオブジェクトに対する参照を取得
SbxOBJECT getSecondaryYAxis ( void ) Y軸の第2数値軸に関する情報を収めたオブジェクトに対する参照を取得
SbxOBJECT getUpBar ( void ) 株価チャートの陽線に関する情報を収めたオブジェクトに対する参照を取得
SbxOBJECT getDownBar ( void ) 株価チャートの陰線に関する情報を収めたオブジェクトに対する参照を取得
SbxOBJECT getMinMaxLine ( void ) 株価チャートのヒゲに関する情報を収めたオブジェクトに対する参照を取得
SbxOBJECT getWall ( void )
SbxOBJECT getFloor ( void )
SbxVOID set3DSettingsToDefault ( void )
SbxVOID setDefaultRotation ( void )
SbxVOID setDefaultIllumination ( void )
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxVOID dispose ( void )
SbxVOID addEventListener ( SbxOBJECT )
SbxVOID removeEventListener ( SbxOBJECT )
SbxOBJECT getDiagram ( void )
SbxVOID setDiagram ( SbxOBJECT )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxOBJECT getPropertySetInfo ( void )
SbxVOID setPropertyValue ( SbxSTRING, SbxVARIANT )
SbxEMPTY getPropertyValue ( SbxSTRING )
SbxVOID addPropertyChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID removePropertyChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID addVetoableChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID removeVetoableChangeListener ( SbxSTRING, SbxOBJECT )
SbxOBJECT getPropertySetInfo ( void )
SbxVOID setPropertyValues ( SbxARRAY, SbxARRAY )
SbxARRAY getPropertyValues ( SbxARRAY )
SbxVOID addPropertiesChangeListener ( SbxARRAY, SbxOBJECT )
SbxVOID removePropertiesChangeListener ( SbxOBJECT )
SbxVOID firePropertiesChangeEvent ( SbxARRAY, SbxOBJECT )
SbxLONG getPropertyState ( SbxSTRING )
SbxARRAY getPropertyStates ( SbxARRAY )
SbxVOID setPropertyToDefault ( SbxSTRING )
SbxEMPTY getPropertyDefault ( SbxSTRING )
SbxARRAY getPropertyStates ( SbxARRAY )
SbxVOID setAllPropertiesToDefault ( void )
SbxVOID setPropertiesToDefault ( SbxARRAY )
SbxARRAY getPropertyDefaults ( SbxARRAY )
SbxOBJECT queryAdapter ( void )

属性の詳細

HasSecondaryXAxis

X軸の第2数値軸を表示する指定。Boolean型の値で、TrueならX軸の第2数値軸を表示する。

HasXAxis

X軸を表示する指定。Boolean型の値で、TrueならX軸を表示する。

HasXAxisDescription

X軸のラベルを表示する指定。Boolean型の値で、TrueならX軸のラベルを表示する。

HasSecondaryXAxisDescription

X軸の第2数値軸のラベルを表示する指定。Boolean型の値で、TrueならX軸の第2数値軸のラベルを表示する。

HasXAxisGrid

X軸の主目盛線を表示する指定。Boolean型の値で、TrueならX軸の主目盛線を表示する。

HasXAxisHelpGrid

X軸の補助目盛線を表示する指定。Boolean型の値で、TrueならX軸の補助目盛線を表示する。

HasXAxisTitle

X軸のタイトルを表示する指定。Boolean型の値で、TrueならX軸のタイトルを表示する。

LineDash

点線・破線に関する情報を収めたオブジェクト(com.sun.star.drawing.LineDashサービスをサポート)。

UpDown

株価チャートの始値を表示する指定で、Boolean型の値。

UpDown
説明
True 始値を表示する(日本流のローソク足)
False 始値を表示しない(欧米流のバーチャート)

株価チャート以外では意味を持たない。

Volume

株価チャートの出来高を表示する指定で、Boolean型の値。

Volume
説明
True 出来高を表示する(株価と出来高を表示)
False 出来高を表示しない(株価のみ表示)

株価チャート以外では意味を持たない。

Position

Dim Position As Object

または

Dim Position As com.sun.star.awt.Point

ダイアグラムの開始位置(左上の位置)を表すオブジェクト。詳細は com.sun.star.awt.Point 参照。

Size

Dim Size As Object

または

Dim Size As com.sun.star.awt.Size

ダイアグラムのサイズ(幅と高さ)を表すオブジェクト。詳細は com.sun.star.awt.Size 参照。

XAxisTitle

X軸のタイトルに関する情報を収めたオブジェクト(com.sun.star.chart.ChartTitle サービスをサポート)。

XAxis

X軸に関する情報を収めたオブジェクト(com.sun.star.chart.ChartAxisサービスをサポート)。

XMainGrid

X軸の主目盛線に関する情報を収めたオブジェクト(com.sun.star.chart.ChartGrid サービスをサポート)。

XHelpGrid

X軸の補助目盛線に関する情報を収めたオブジェクト(com.sun.star.chart.ChartGrid サービスをサポート)。

SecondaryXAxis

X軸の第2数値軸に関する情報を収めたオブジェクト(com.sun.star.chart.chartAxisサービスをサポート)。

UpBar

株価チャートの陽線に関する情報を収めたオブジェクト(com.sun.star.comp.chart.ChartAreaサービスをサポート)。

DownBar

株価チャートの陰線に関する情報を収めたオブジェクト(com.sun.star.comp.chart.ChartAreaサービスをサポート)。

MinMaxLine

株価チャートのヒゲに関する情報を収めたオブジェクト(com.sun.star.comp.chart.ChartLineサービスをサポート)。

Wall

グラフの壁面(3Dグラフのみ。com.sun.star.chart.ChartAreaサービスをサポート)。

Floor

グラフの床面(3Dグラフのみ。com.sun.star.chart.ChartAreaサービスをサポート)。

Dbg_Properties

Dim Dbg_Properties As String

このオブジェクトが持つ属性の一覧(各属性がセミコロン記号で区切られた文字列)

Dbg_Methods

Dim Dbg_Methods As String

このオブジェクトが持つメソッドの一覧(各メソッドがセミコロン記号で区切られた文字列)

メソッドの詳細

queryInterface

インタフェースの問い合わせ

importClass(Packages.com.sun.star.uno.UnoRuntime);
importClass(Packages.com.sun.star.sheet.XSpreadsheetDocument);

oDoc = XSCRIPTCONTEXT.getDocument();

xSDoc = UnoRuntime.queryInterface(XSpreadsheetDocument, oDoc);

getPosition

Function getPosition As Object
引数

無し

戻り値

ダイアグラムの開始位置(左上の位置)を表すオブジェクト (com.sun.star.awt.Point) への参照を返す。

setPosition

Sub setPosition( point As Object)

ダイアグラムの開始位置(左上の位置)を設定する。

戻り値

無し

引数
point
ダイアグラムの開始位置(左上の位置)を表すオブジェクト (com.sun.star.awt.Point)
使用例
Dim oChart As Object
Dim oPoint As Object

oChart = ThisComponent.Sheets.getByName("表1").Charts.getByName("Candle")
oPoint = oChart.embeddedObject.Diagram.getPosition
oPoint.X = 1000
oChart.embeddedObject.Diagram.setPosition(oPoint)

getSize

Function getSize As Object
引数

無し

戻り値

ダイアグラムのサイズ(幅と高さ)を表すオブジェクト (com.sun.star.awt.Size) への参照を返す。

setSize

ダイアグラムのサイズ(幅と高さ)を設定する。

Sub setSize( size As Object)
引数
size
ダイアグラムのサイズ(幅と高さ)を表すオブジェクト (com.sun.star.awt.Size)
戻り値

無し

使用例
Dim oChart As Object
Dim oSize As Object

oChart = ThisComponent.Sheets.getByName("表1").Charts.getByName("Candle")
oSize = oChart.embeddedObject.Diagram.getSize
oSize.Width = 20000
oChart.embeddedObject.Diagram.setSize(oChart)

getDataRowProperties

データ系列(com.sun.star.comp.chart.DataSeries)への参照を返す。

Function getDataRowProperties( index As Long) As Object
引数
index
データ系列の番号
戻り値

com.sun.star.comp.chart.DataSeries への参照

使用例
Dim oChart As Object
Dim oDiagram As Object
Dim oDataRowProperty As Object

oChart = ThisComponent.Sheets.getByName("表1").Charts.getByName("グラフ1")
oDiagram = oChart.embeddedObject.Diagram
oDataRowProperty = oDiagram.getDataRowProperties(1)
oDataRowProperty.LineColor = RGB(255, 0, 0)
oDataRowProperty.LineWidth = 40
oDataRowProperty.LineStyle = com.sun.star.drawing.LineStyle.SOLID

getXAxis

X軸に関する情報を収めたオブジェクトに対する参照を取得する。

呼び出し形式
Function getXAxis As Object
引数

無し

戻り値

X軸に関する情報を収めたオブジェクト(com.sun.star.chart.ChartAxisサービスをサポート)に対する参照

getXMainGrid

X軸の主目盛線に関する情報を収めたオブジェクトに対する参照を取得する。

呼び出し形式
Function getXMainGrid As Object
引数

無し

戻り値

X軸の主目盛線に関する情報を収めたオブジェクト(com.sun.star.chart.ChartGrid サービスをサポート)に対する参照

getXHelpGrid

X軸の補助目盛線に関する情報を収めたオブジェクトに対する参照を取得する。

呼び出し形式
Function getXHelpGrid As Object
引数

無し

戻り値

X軸の補助目盛線に関する情報を収めたオブジェクト(com.sun.star.chart.ChartGrid サービスをサポート)に対する参照

getSecondaryXAxis

X軸の第2数値軸に関する情報を収めたオブジェクトに対する参照を取得する。

呼び出し形式
Function getSecondaryXAxis As Object
引数

無し

戻り値

X軸の第2数値軸に関する情報を収めたオブジェクト(com.sun.star.chart.ChartAxisサービスをサポート)に対する参照

getUpBar

株価チャートの陽線に関する情報を収めたオブジェクトに対する参照を取得する。

呼び出し形式
Function getUpBar As Object
引数

無し

戻り値

株価チャートの陽線に関する情報を収めたオブジェクト(com.sun.star.comp.chart.ChartAreaサービスをサポート)に対する参照

getDownBar

株価チャートの陰線に関する情報を収めたオブジェクトに対する参照を取得する。

呼び出し形式
Function getDownBar As Object
引数

無し

戻り値

株価チャートの陰線に関する情報を収めたオブジェクト(com.sun.star.comp.chart.ChartAreaサービスをサポート)に対する参照

getMinMaxLine

株価チャートのヒゲに関する情報を収めたオブジェクトに対する参照を取得する。

呼び出し形式

Function getMinMaxLine As Object
引数

無し

戻り値

株価チャートのヒゲに関する情報を収めたオブジェクト(com.sun.star.comp.chart.ChartAreaサービスをサポート)に対する参照

getWall

グラフの壁面(3Dグラフのみ。com.sun.star.chart.ChartAreaサービスをサポート)オブジェクトに対する参照を取得する。

呼び出し形式
Function getWall As Object
引数

無し

戻り値

グラフの壁面(3Dグラフのみ。com.sun.star.chart.ChartAreaサービスをサポート)オブジェクトに対する参照

getFloor

グラフの床面(3Dグラフのみ。com.sun.star.chart.ChartAreaサービスをサポート)オブジェクトに対する参照を取得する。

呼び出し形式

Function getFloor As Object
引数

無し

戻り値

グラフの壁面(3Dグラフのみ。com.sun.star.chart.ChartAreaサービスをサポート)オブジェクトに対する参照

com.sun.star.comp.chart.Legend

ChartオブジェクトのプロパティであるLegendは、グラフの凡例を表すオブジェクトです。

グラフの凡例の有無はChartオブジェクトのHasLegendプロパティで設定します。デフォルトでHasLegendの値はTrue(凡例あり)になっています。グラフの凡例を表示しないようにする例を次に示します。

Chart.HasLegend = False

プロパティ

説明
Legendのプロパティ
プロパティ
Alignment 凡例の表示位置の指定

Alignment

凡例の表示位置の指定(com.sun.star.chart.ChartLegendPositionに定められた値)。

LegendオブジェクトのAlignmentプロパティ
凡例の位置
com.sun.star.chart.ChartLegendPosition.TOP
com.sun.star.chart.ChartLegendPosition.RIGHT
com.sun.star.chart.ChartLegendPosition.BOTTOM
com.sun.star.chart.ChartLegendPosition.LEFT

com.sun.star.comp.chart.Title

com.sun.star.comp.chart.Titleは、OpenOffice/LibreOfficeにおけるチャートのタイトルを表すオブジェクトです。

プロパティの概要

com.sun.star.comp.chart.Titleのプロパティ一覧を次に示す。

プロパティ 概要
SbxBOOL/void CharAutoKerning
SbxLONG CharColor
SbxBOOL CharContoured
SbxINTEGER CharEmphasis
SbxINTEGER CharEscapement
SbxINTEGER CharEscapementHeight
SbxINTEGER CharFontCharSet
SbxINTEGER CharFontCharSetAsian
SbxINTEGER CharFontCharSetComplex
SbxINTEGER CharFontFamily
SbxINTEGER CharFontFamilyAsian
SbxINTEGER CharFontFamilyComplex
SbxSTRING CharFontName
SbxSTRING CharFontNameAsian
SbxSTRING CharFontNameComplex
SbxINTEGER CharFontPitch
SbxINTEGER CharFontPitchAsian
SbxINTEGER CharFontPitchComplex
SbxSTRING/void CharFontStyleName
SbxSTRING/void CharFontStyleNameAsian
SbxSTRING/void CharFontStyleNameComplex
SbxSINGLE CharHeight
SbxSINGLE CharHeightAsian
SbxSINGLE CharHeightComplex
SbxINTEGER/void CharKerning
SbxOBJECT CharLocale
SbxOBJECT CharLocaleAsian
SbxOBJECT CharLocaleComplex
SbxLONG CharPosture
SbxLONG CharPostureAsian
SbxLONG CharPostureComplex
SbxINTEGER CharRelief
SbxBOOL CharShadowed
SbxINTEGER CharStrikeout
SbxINTEGER CharUnderline
SbxLONG/void CharUnderlineColor
SbxBOOL CharUnderlineHasColor
SbxSINGLE CharWeight
SbxSINGLE CharWeightAsian
SbxSINGLE CharWeightComplex
SbxBOOL CharWordMode
SbxOBJECT/void ChartUserDefinedAttributes
SbxBOOL FillBackground
SbxBOOL FillBitmapLogicalSize
SbxLONG FillBitmapMode
SbxSTRING/void FillBitmapName
SbxINTEGER FillBitmapOffsetX
SbxINTEGER FillBitmapOffsetY
SbxINTEGER FillBitmapPositionOffsetX
SbxINTEGER FillBitmapPositionOffsetY
SbxLONG FillBitmapRectanglePoint
SbxLONG FillBitmapSizeX
SbxLONG FillBitmapSizeY
SbxLONG/void FillColor
SbxSTRING/void FillGradientName
SbxINTEGER FillGradientStepCount
SbxSTRING/void FillHatchName
SbxLONG FillStyle
SbxINTEGER FillTransparence
SbxSTRING/void FillTransparenceGradientName
SbxLONG LineColor
SbxOBJECT/void LineDash
SbxSTRING/void LineDashName
SbxLONG LineJoint
SbxLONG LineStyle
SbxINTEGER LineTransparence
SbxLONG LineWidth
SbxOBJECT/void ParaUserDefinedAttributes
SbxBOOL StackedText
SbxSTRING/void String タイトルとして表示するテキスト
SbxLONG TextRotation テキストの回転角
SbxOBJECT/void TextUserDefinedAttributes
SbxOBJECT/void UserDefinedAttributes
SbxSTRING ShapeType
SbxOBJECT Position
SbxOBJECT Size
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxARRAY Types
SbxARRAY ImplementationId
SbxOBJECT PropertySetInfo
SbxSTRING PropertyToDefault
SbxARRAY PropertiesToDefault
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

プロパティの詳細

String

タイトルまたはサブタイトルとして表示するテキストで、String型の値。

TextRotation

100分の1度単位で指定したテキストの回転角で、Long型の値。

com.sun.star.comp.chart2.ChartModel

OpenOffice BasicにおけるChartModelは、チャート(グラフ)を操作するためのオブジェクトです。この記事では、その使い方をサンプルを交えてご紹介します。

プロパティ

com.sun.star.comp.chart2.ChartModelのプロパティ一覧を次に示す。

ChartModelのプロパティ
プロパティ 概要
SbxOBJECT/void AddIn
SbxOBJECT/void AdditionalShapes
SbxSTRING/void BaseDiagram
SbxBOOL DataSourceLabelsInFirstColumn
SbxBOOL DataSourceLabelsInFirstRow
SbxBOOL HasLegend 凡例を表示する指定
SbxBOOL HasMainTitle タイトルを表示する指定
SbxBOOL HasSubTitle サブタイトルを表示する指定
SbxBOOL RefreshAddInAllowed
SbxSTRING Location
SbxBOOL Modified
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxSTRING URL
SbxARRAY Args
SbxOBJECT CurrentController
SbxOBJECT CurrentSelection
SbxOBJECT FirstDiagram
SbxOBJECT DataProvider
SbxOBJECT ChartTypeManager
SbxOBJECT PageBackground
SbxARRAY UsedRangeRepresentations
SbxOBJECT UsedData
SbxOBJECT RangeHighlighter
SbxARRAY Arguments
SbxOBJECT TitleObject
SbxARRAY AvailableServiceNames
SbxOBJECT DocumentStorage
SbxOBJECT NumberFormatSettings
SbxOBJECT NumberFormats
SbxOBJECT Parent
SbxARRAY TransferDataFlavors
SbxOBJECT UndoManager
SbxARRAY Types
SbxARRAY ImplementationId
SbxOBJECT Title グラフのタイトル
SbxOBJECT SubTitle グラフのサブタイトル
SbxOBJECT Legend グラフの凡例表示
SbxOBJECT Area グラフ背景の表示エリア
SbxOBJECT Diagram ダイアグラム
SbxOBJECT Data
SbxOBJECT DrawPage
SbxOBJECT Delegator
SbxOBJECT PropertySetInfo
SbxSTRING PropertyToDefault
SbxARRAY PropertiesToDefault
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

HasLegend

凡例を表示する指定。Boolean型の値がTrueなら凡例を表示する。Falseなら凡例を表示しない。

com.sun.star.comp.chart2.ChartModel オブジェクトのプロパティであるLegendは、凡例を表すオブジェクトです。凡例の有無はCharオブジェクトのHasLegendプロパティで設定します。デフォルトでHasLegendの値はTrue(凡例あり)になっています。グラフの凡例を表示しないようにする例を次に示します。

Chart.HasLegend = False

HasMainTitle

タイトル(題目)を表示する指定。Boolean型の値がTrueならタイトルを表示する。Falseならタイトルを表示しない。

グラフにタイトルを付ける例を次に示す。

Chart.HasMainTitle = True
Chart.Title.String = "メインタイトル"

HasSubTitle

サブタイトル(副題目)を表示する指定。Boolean型の値がTrueならサブタイトルを表示する。Falseならサブタイトルを表示しない。

グラフにサブタイトルを付ける例を次に示す。

Chart.HasSubTitle = True
Chart.SubTitle.String = "サブタイトル"

Title

グラフのタイトル(題目)に関する情報を集めたオブジェクト(com.sun.star.comp.chart.Titleサービスをサポート)。

SubTitle

グラフのサブタイトル(副題目)に関する情報を集めたオブジェクト(com.sun.star.comp.chart.Titleサービスをサポート)。

Legend

グラフの凡例表示に関する情報を集めたオブジェクト(com.sun.star.comp.chart.Legendサービスをサポート)。

Area

グラフ背景の表示エリア(com.sun.star.chart.Areaサービスをサポート)。

ここで言うグラフの背景(グラフエリア)とは、タイトルやサブタイトル、凡例などの表示位置も含めた、グラフ全体をカバーする領域である。

Diagram

Dim Diagram As Object または Dim Diagram As com.sun.star.comp.chart.Diagram

ダイアグラムを表す。詳細は com.sun.star.comp.chart.Diagram 参照。

Dbg_Properties

Dim Dbg_Properties As String

このオブジェクトが持つプロパティの一覧(各プロパティがセミコロン記号で区切られた文字列)

Dbg_Methods

Dim Dbg_Methods As String

このオブジェクトが持つメソッドの一覧(各メソッドがセミコロン記号で区切られた文字列)

メソッド

com.sun.star.comp.chart2.ChartModelのメソッド一覧を次に示す。

ChartModelのメソッド
メソッド 概要
SbxEMPTY queryInterface ( SbxOBJECT )
SbxVOID addCloseListener ( SbxOBJECT )
SbxVOID removeCloseListener ( SbxOBJECT )
SbxVOID close ( SbxBOOL )
SbxBOOL hasLocation ( void )
SbxSTRING getLocation ( void )
SbxBOOL isReadonly ( void )
SbxVOID store ( void )
SbxVOID storeAsURL ( SbxSTRING, SbxARRAY )
SbxVOID storeToURL ( SbxSTRING, SbxARRAY )
SbxVOID storeSelf ( SbxARRAY )
SbxVOID addModifyListener ( SbxOBJECT )
SbxVOID removeModifyListener ( SbxOBJECT )
SbxBOOL isModified ( void )
SbxVOID setModified ( SbxBOOL )
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxVOID dispose ( void )
SbxVOID addEventListener ( SbxOBJECT )
SbxVOID removeEventListener ( SbxOBJECT )
SbxBOOL attachResource ( SbxSTRING, SbxARRAY )
SbxSTRING getURL ( void )
SbxARRAY getArgs ( void )
SbxVOID connectController ( SbxOBJECT )
SbxVOID disconnectController ( SbxOBJECT )
SbxVOID lockControllers ( void ) グラフの描画を抑制する
SbxVOID unlockControllers ( void ) グラフの描画を再開する
SbxBOOL hasControllersLocked ( void )
SbxOBJECT getCurrentController ( void )
SbxVOID setCurrentController ( SbxOBJECT )
SbxOBJECT getCurrentSelection ( void )
SbxOBJECT getFirstDiagram ( void )
SbxVOID setFirstDiagram ( SbxOBJECT )
SbxVOID createInternalDataProvider ( SbxBOOL )
SbxBOOL hasInternalDataProvider ( void )
SbxOBJECT getDataProvider ( void )
SbxVOID setChartTypeManager ( SbxOBJECT )
SbxOBJECT getChartTypeManager ( void )
SbxOBJECT getPageBackground ( void )
SbxVOID attachDataProvider ( SbxOBJECT )
SbxVOID setArguments ( SbxARRAY )
SbxARRAY getUsedRangeRepresentations ( void )
SbxOBJECT getUsedData ( void )
SbxVOID attachNumberFormatsSupplier ( SbxOBJECT )
SbxOBJECT getRangeHighlighter ( void )
SbxOBJECT getTitleObject ( void )
SbxVOID setTitleObject ( SbxOBJECT )
SbxVOID initNew ( void )
SbxVOID load ( SbxARRAY )
SbxOBJECT createClone ( void )
SbxVOID setVisualAreaSize ( SbxINT64, SbxOBJECT )
SbxOBJECT getVisualAreaSize ( SbxINT64 )
SbxOBJECT getPreferredVisualRepresentation ( SbxINT64 )
SbxLONG getMapUnit ( SbxINT64 )
SbxOBJECT createInstance ( SbxSTRING ) ダイアグラムを作成する
SbxOBJECT createInstanceWithArguments ( SbxSTRING, SbxARRAY )
SbxARRAY getAvailableServiceNames ( void )
SbxVOID loadFromStorage ( SbxOBJECT, SbxARRAY )
SbxVOID storeToStorage ( SbxOBJECT, SbxARRAY )
SbxVOID switchToStorage ( SbxOBJECT )
SbxOBJECT getDocumentStorage ( void )
SbxVOID addStorageChangeListener ( SbxOBJECT )
SbxVOID removeStorageChangeListener ( SbxOBJECT )
SbxINT64 getSomething ( SbxARRAY )
SbxOBJECT getNumberFormatSettings ( void )
SbxOBJECT getNumberFormats ( void )
SbxOBJECT getParent ( void )
SbxVOID setParent ( SbxOBJECT )
SbxVOID disposing ( SbxOBJECT )
SbxVOID modified ( SbxOBJECT )
SbxEMPTY getTransferData ( SbxOBJECT )
SbxARRAY getTransferDataFlavors ( void )
SbxBOOL isDataFlavorSupported ( SbxOBJECT )
SbxOBJECT getUndoManager ( void )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxOBJECT queryAdapter ( void )
SbxOBJECT getTitle ( void )
SbxOBJECT getSubTitle ( void )
SbxOBJECT getLegend ( void )
SbxOBJECT getArea ( void )
SbxOBJECT getDiagram ( void )
SbxVOID setDiagram ( SbxOBJECT )
SbxOBJECT getData ( void )
SbxVOID attachData ( SbxOBJECT )
SbxOBJECT getDrawPage ( void )
SbxVOID setDelegator ( SbxOBJECT )
SbxEMPTY queryAggregation ( SbxOBJECT )
SbxOBJECT getPropertySetInfo ( void )
SbxVOID setPropertyValue ( SbxSTRING, SbxVARIANT )
SbxEMPTY getPropertyValue ( SbxSTRING )
SbxVOID addPropertyChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID removePropertyChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID addVetoableChangeListener ( SbxSTRING, SbxOBJECT )
SbxVOID removeVetoableChangeListener ( SbxSTRING, SbxOBJECT )
SbxOBJECT getPropertySetInfo ( void )
SbxVOID setPropertyValues ( SbxARRAY, SbxARRAY )
SbxARRAY getPropertyValues ( SbxARRAY )
SbxVOID addPropertiesChangeListener ( SbxARRAY, SbxOBJECT )
SbxVOID removePropertiesChangeListener ( SbxOBJECT )
SbxVOID firePropertiesChangeEvent ( SbxARRAY, SbxOBJECT )
SbxLONG getPropertyState ( SbxSTRING )
SbxARRAY getPropertyStates ( SbxARRAY )
SbxVOID setPropertyToDefault ( SbxSTRING )
SbxEMPTY getPropertyDefault ( SbxSTRING )
SbxARRAY getPropertyStates ( SbxARRAY )
SbxVOID setAllPropertiesToDefault ( void )
SbxVOID setPropertiesToDefault ( SbxARRAY )
SbxARRAY getPropertyDefaults ( SbxARRAY )

lockControllers

Sub lockControllers

グラフの描画を早くするため、描画の更新を抑制する。

引数

無し

戻り値

無し

使用例
oChart As Object

oChart = Charts.getByName("MyChart").embeddedObject
oChart.LockControllers

unlockControllers

Sub unlockControllers

描画の更新を再開する。

引数

無し

戻り値

無し

使用例
oChart As Object

oChart = Charts.getByName("MyChart").embeddedObject
oChart.UnLockControllers

getFirstDiagram

最初のダイアグラム・オブジェクトへの参照を返す

Function getFirstDiagram As Object
引数

無し

戻り値

最初のダイアグラム・オブジェクト(com.sun.star.comp.chart2.Diagram)への参照を返す

getDataProvider

データプロバイダ・オブジェクトへの参照を返す

Function getDataProvider As Object
引数

無し

戻り値

データプロバイダ・オブジェクト(ScChart2DataProvider)への参照を返す

createInstance

Function createInstance(name As String) As Object

ダイアグラムを作成する。

引数
name
グラフの種類
グラフの種類
種類 説明
com.sun.star.chart.BarDiagram
com.sun.star.chart.PieDiagram
com.sun.star.chart.DonutDiagram 扇(ドーナツ)
com.sun.star.chart.AreaDiagram 表面
com.sun.star.chart.LineDiagram
com.sun.star.chart.XYDiagram 散布図
com.sun.star.chart.NetDiagram レーダー網
com.sun.star.chart.StockDiagram 株価
com.sun.star.chart.StackableDiagram 積み上げグラフ
戻り値

作成したダイアグラム (com.sun.star.comp.chart.Diagram) への参照を返す。

com.sun.star.table.CellRangeAddress

CellRangeAddress は OpenOffice Calc のセル範囲を表わすオブジェクトです。

プロパティ

CellRangeAddressのプロパティ
名前 種類 説明
Sheet Integer テーブルシート番号(0~)
StartColumn Long
StartRow Long
EndColumn Long
EndRow Long

stardiv.Toolkit.UnoCheckBoxControl

UnoCheckBoxControlは、ダイアログコントロールの一種であるチェックボックスを表すオブジェクトである。

チェックボックスは基本的にYesまたはNoの形式の情報を入力するために使用する。ただし、モード設定によっては、このような2 つのステータス間だけでなく、3 つのステータス間で選択することもできる。通常使用するのはYes かNo かの選択肢だが、どちらともつかない中間状態が選択肢としてあり得る場合は、それを示すステータスも表示できる。

属性の概要

stardiv.Toolkit.UnoCheckBoxControlの属性
属性 説明
SbxSTRING Label コントロール要素に表示するラベル(タイトル)
SbxSTRING ActionCommand
SbxINTEGER State チェックボックスの状態
SbxOBJECT MinimumSize
SbxOBJECT PreferredSize
SbxARRAY Types
SbxARRAY ImplementationId
SbxOBJECT Context
SbxOBJECT Peer
SbxOBJECT Model
SbxOBJECT View
SbxBOOL DesignMode
SbxOBJECT PosSize
SbxOBJECT OutputSize
SbxBOOL Visible
SbxBOOL Enable
SbxOBJECT Graphics
SbxOBJECT Size
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxOBJECT AccessibleContext
SbxOBJECT Delegator
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

メソッドの概要

stardiv.Toolkit.UnoCheckBoxControlのメソッド
メソッド 説明
SbxEMPTY queryInterface ( SbxOBJECT )
SbxVOID addActionListener ( SbxOBJECT )
SbxVOID removeActionListener ( SbxOBJECT )
SbxVOID setLabel ( SbxSTRING )
SbxVOID setActionCommand ( SbxSTRING )
SbxVOID addItemListener ( SbxOBJECT )
SbxVOID removeItemListener ( SbxOBJECT )
SbxINTEGER getState ( void )
SbxVOID setState ( SbxINTEGER )
SbxVOID setLabel ( SbxSTRING )
SbxVOID enableTriState ( SbxBOOL )
SbxVOID disposing ( SbxOBJECT )
SbxVOID itemStateChanged ( SbxOBJECT )
SbxOBJECT getMinimumSize ( void )
SbxOBJECT getPreferredSize ( void )
SbxOBJECT calcAdjustedSize ( SbxOBJECT )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxVOID dispose ( void )
SbxVOID addEventListener ( SbxOBJECT )
SbxVOID removeEventListener ( SbxOBJECT )
SbxVOID setContext ( SbxOBJECT )
SbxOBJECT getContext ( void )
SbxVOID createPeer ( SbxOBJECT, SbxOBJECT )
SbxOBJECT getPeer ( void )
SbxBOOL setModel ( SbxOBJECT )
SbxOBJECT getModel ( void )
SbxOBJECT getView ( void )
SbxVOID setDesignMode ( SbxBOOL )
SbxBOOL isDesignMode ( void )
SbxBOOL isTransparent ( void )
SbxVOID setPosSize ( SbxLONG, SbxLONG, SbxLONG, SbxLONG, SbxINTEGER )
SbxOBJECT getPosSize ( void )
SbxVOID setVisible ( SbxBOOL )
SbxVOID setEnable ( SbxBOOL ) コントロールの有効・無効を切り替える
SbxVOID setFocus ( void )
SbxVOID addWindowListener ( SbxOBJECT )
SbxVOID removeWindowListener ( SbxOBJECT )
SbxVOID addFocusListener ( SbxOBJECT )
SbxVOID removeFocusListener ( SbxOBJECT )
SbxVOID addKeyListener ( SbxOBJECT )
SbxVOID removeKeyListener ( SbxOBJECT )
SbxVOID addMouseListener ( SbxOBJECT )
SbxVOID removeMouseListener ( SbxOBJECT )
SbxVOID addMouseMotionListener ( SbxOBJECT )
SbxVOID removeMouseMotionListener ( SbxOBJECT )
SbxVOID addPaintListener ( SbxOBJECT )
SbxVOID removePaintListener ( SbxOBJECT )
SbxVOID setOutputSize ( SbxOBJECT )
SbxOBJECT getOutputSize ( void )
SbxBOOL isVisible ( void )
SbxBOOL isActive ( void )
SbxBOOL isEnabled ( void ) コントロールの有効・無効を返す
SbxBOOL hasFocus ( void )
SbxBOOL setGraphics ( SbxOBJECT )
SbxOBJECT getGraphics ( void )
SbxOBJECT getSize ( void )
SbxVOID draw ( SbxLONG, SbxLONG )
SbxVOID setZoom ( SbxSINGLE, SbxSINGLE )
SbxVOID propertiesChange ( SbxARRAY )
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxOBJECT getAccessibleContext ( void )
SbxVOID addModeChangeListener ( SbxOBJECT )
SbxVOID removeModeChangeListener ( SbxOBJECT )
SbxVOID addModeChangeApproveListener ( SbxOBJECT )
SbxVOID removeModeChangeApproveListener ( SbxOBJECT )
SbxOBJECT queryAdapter ( void )
SbxVOID setDelegator ( SbxOBJECT )
SbxEMPTY queryAggregation ( SbxOBJECT )

属性の詳細

State

チェックボックスの状態を表すInteger型の値

State
説明
0 No
1 Yes
2 中間状態

Dbg_Properties

Dim Dbg_Properties As String

このオブジェクトが持つ属性(プロパティ)の一覧(各属性がセミコロン記号で区切られた文字列)

Dbg_Methods

Dim Dbg_Methods As String

このオブジェクトが持つメソッドの一覧(各メソッドがセミコロン記号で区切られた文字列)

メソッドの詳細

setEnable

チェックボックスの有効・無効を切り替える。無効にしたコントロールは淡色(灰色)表示となり、入力や選択が行えなくなる。

チェックボックスが有効か無効かを判定するには、isEnabledメソッドを使用する。

呼び出し形式
Sub setEnable( flag As Boolean)
引数
flag
チェックボックスを有効するか無効にするかを指定するフラグ。有効する場合はTrue、無効にする場合はFalse。
戻り値

無し

isEnabled

チェックボックスが有効か無効かを表すBoolean値を返す。

チェックボックスの有効・無効を切り替えるには、setEnableメソッドを使用する。

呼び出し形式
Function setEnable As Boolean
引数

無し

戻り値

チェックボックスが有効か無効かを表すBoolean値。有効ならTrue、無効ならFalse。

stardiv.Toolkit.UnoDateFieldControl

UnoDateFieldControlは、ダイアログコントロールの一種である日付フィールドを表すオブジェクトである。

属性の概要

stardiv.Toolkit.UnoDateFieldControlの属性
属性 説明
SbxARRAY Types
SbxARRAY ImplementationId
SbxLONG Date 日付フィールドに入力された日付
SbxLONG Min
SbxLONG Max
SbxLONG First
SbxLONG Last
SbxBOOL LongFormat
SbxBOOL StrictFormat
SbxOBJECT Context
SbxOBJECT Peer
SbxOBJECT Model
SbxOBJECT View
SbxBOOL DesignMode
SbxOBJECT PosSize
SbxOBJECT OutputSize
SbxBOOL Visible
SbxBOOL Enable
SbxOBJECT Graphics
SbxOBJECT Size
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxOBJECT AccessibleContext
SbxOBJECT Delegator
SbxSTRING Text
SbxSTRING SelectedText
SbxOBJECT Selection
SbxINTEGER MaxTextLen
SbxBOOL Editable
SbxOBJECT MinimumSize
SbxOBJECT PreferredSize
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

メソッドの概要

stardiv.Toolkit.UnoDateFieldControlのメソッド
メソッド 説明
SbxEMPTY queryInterface ( SbxOBJECT )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxVOID setDate ( SbxLONG )
SbxLONG getDate ( void )
SbxVOID setMin ( SbxLONG )
SbxLONG getMin ( void )
SbxVOID setMax ( SbxLONG )
SbxLONG getMax ( void )
SbxVOID setFirst ( SbxLONG )
SbxLONG getFirst ( void )
SbxVOID setLast ( SbxLONG )
SbxLONG getLast ( void )
SbxVOID setLongFormat ( SbxBOOL )
SbxBOOL isLongFormat ( void )
SbxVOID setEmpty ( void )
SbxBOOL isEmpty ( void )
SbxVOID setStrictFormat ( SbxBOOL )
SbxBOOL isStrictFormat ( void )
SbxVOID addSpinListener ( SbxOBJECT )
SbxVOID removeSpinListener ( SbxOBJECT )
SbxVOID up ( void )
SbxVOID down ( void )
SbxVOID first ( void )
SbxVOID last ( void )
SbxVOID enableRepeat ( SbxBOOL )
SbxVOID dispose ( void )
SbxVOID addEventListener ( SbxOBJECT )
SbxVOID removeEventListener ( SbxOBJECT )
SbxVOID setContext ( SbxOBJECT )
SbxOBJECT getContext ( void )
SbxVOID createPeer ( SbxOBJECT, SbxOBJECT )
SbxOBJECT getPeer ( void )
SbxBOOL setModel ( SbxOBJECT )
SbxOBJECT getModel ( void )
SbxOBJECT getView ( void )
SbxVOID setDesignMode ( SbxBOOL )
SbxBOOL isDesignMode ( void )
SbxBOOL isTransparent ( void )
SbxVOID setPosSize ( SbxLONG, SbxLONG, SbxLONG, SbxLONG, SbxINTEGER )
SbxOBJECT getPosSize ( void )
SbxVOID setVisible ( SbxBOOL )
SbxVOID setEnable ( SbxBOOL ) コントロールの有効・無効を切り替える
SbxVOID setFocus ( void )
SbxVOID addWindowListener ( SbxOBJECT )
SbxVOID removeWindowListener ( SbxOBJECT )
SbxVOID addFocusListener ( SbxOBJECT )
SbxVOID removeFocusListener ( SbxOBJECT )
SbxVOID addKeyListener ( SbxOBJECT )
SbxVOID removeKeyListener ( SbxOBJECT )
SbxVOID addMouseListener ( SbxOBJECT )
SbxVOID removeMouseListener ( SbxOBJECT )
SbxVOID addMouseMotionListener ( SbxOBJECT )
SbxVOID removeMouseMotionListener ( SbxOBJECT )
SbxVOID addPaintListener ( SbxOBJECT )
SbxVOID removePaintListener ( SbxOBJECT )
SbxVOID setOutputSize ( SbxOBJECT )
SbxOBJECT getOutputSize ( void )
SbxBOOL isVisible ( void )
SbxBOOL isActive ( void )
SbxBOOL isEnabled ( void ) コントロールの有効・無効を返す
SbxBOOL hasFocus ( void )
SbxBOOL setGraphics ( SbxOBJECT )
SbxOBJECT getGraphics ( void )
SbxOBJECT getSize ( void )
SbxVOID draw ( SbxLONG, SbxLONG )
SbxVOID setZoom ( SbxSINGLE, SbxSINGLE )
SbxVOID disposing ( SbxOBJECT )
SbxVOID propertiesChange ( SbxARRAY )
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxOBJECT getAccessibleContext ( void )
SbxVOID addModeChangeListener ( SbxOBJECT )
SbxVOID removeModeChangeListener ( SbxOBJECT )
SbxVOID addModeChangeApproveListener ( SbxOBJECT )
SbxVOID removeModeChangeApproveListener ( SbxOBJECT )
SbxOBJECT queryAdapter ( void )
SbxVOID setDelegator ( SbxOBJECT )
SbxEMPTY queryAggregation ( SbxOBJECT )
SbxVOID addTextListener ( SbxOBJECT )
SbxVOID removeTextListener ( SbxOBJECT )
SbxVOID setText ( SbxSTRING )
SbxVOID insertText ( SbxOBJECT, SbxSTRING )
SbxSTRING getText ( void )
SbxSTRING getSelectedText ( void )
SbxVOID setSelection ( SbxOBJECT )
SbxOBJECT getSelection ( void )
SbxBOOL isEditable ( void )
SbxVOID setEditable ( SbxBOOL )
SbxVOID setMaxTextLen ( SbxINTEGER )
SbxINTEGER getMaxTextLen ( void )
SbxVOID textChanged ( SbxOBJECT )
SbxOBJECT getMinimumSize ( void )
SbxOBJECT getPreferredSize ( void )
SbxOBJECT calcAdjustedSize ( SbxOBJECT )
SbxOBJECT getMinimumSize ( SbxINTEGER, SbxINTEGER )
SbxVOID getColumnsAndLines ( SbxINTEGER, SbxINTEGER )

属性の詳細

Date

日付フィールドに入力された日付を表すLong値

使用例
Dim oDialog As Object
Dim oDateField As Object
Dim lDate As Long

BasicLibraries.LoadLibrary("Tools")
oDialog = LoadDialog("Standard", "MyDialog")
oDialog.execute

oDateField = oDialog.GetControl("DateField1")
lDate = oDateField.Date

Dbg_Properties

Dim Dbg_Properties As String

このオブジェクトが持つ属性(プロパティ)の一覧(各属性がセミコロン記号で区切られた文字列)

Dbg_Methods

Dim Dbg_Methods As String

このオブジェクトが持つメソッドの一覧(各メソッドがセミコロン記号で区切られた文字列)

メソッドの詳細

setEnable

ラジオボタンの有効・無効を切り替える。無効にしたコントロールは淡色(灰色)表示となり、入力や選択が行えなくなる。

ラジオボタンが有効か無効かを判定するには、isEnabledメソッドを使用する。

呼び出し形式
Sub setEnable( flag As Boolean)
引数
flag
ラジオボタンを有効するか無効にするかを指定するフラグ。有効する場合はTrue、無効にする場合はFalse。
戻り値

無し

isEnabled

ラジオボタンが有効か無効かを表すBoolean値を返す。

ラジオボタンの有効・無効を切り替えるには、setEnableメソッドを使用する。

呼び出し形式
Function setEnable As Boolean
引数

無し

戻り値

ラジオボタンが有効か無効かを表すBoolean値。有効ならTrue、無効ならFalse。

stardiv.Toolkit.UnoDialogControl

stardiv.Toolkit.UnoDialogControlはOpenOffice/LibreOffice Basicにおいてダイアログを制御するためのクラスです。

属性の概要

stardiv.Toolkit.UnoDialogControlの属性
属性 説明
SbxOBJECT MenuBar
SbxSTRING Title
SbxARRAY Types
SbxARRAY ImplementationId
SbxARRAY TabControllers
SbxARRAY Controls
SbxSTRING StatusText
SbxOBJECT ElementType
SbxARRAY Identifiers
SbxOBJECT Context
SbxOBJECT Peer
SbxOBJECT Model
SbxOBJECT View
SbxBOOL DesignMode
SbxOBJECT PosSize
SbxOBJECT OutputSize
SbxBOOL Visible
SbxBOOL Enable
SbxOBJECT Graphics
SbxOBJECT Size
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxOBJECT AccessibleContext
SbxOBJECT Delegator
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

メソッドの概要

stardiv.Toolkit.UnoDialogControlのメソッド
メソッド 説明
SbxEMPTY queryInterface ( SbxOBJECT )
SbxVOID disposing ( SbxOBJECT )
SbxVOID elementInserted ( SbxOBJECT )
SbxVOID elementRemoved ( SbxOBJECT )
SbxVOID elementReplaced ( SbxOBJECT )
SbxVOID addTopWindowListener ( SbxOBJECT )
SbxVOID removeTopWindowListener ( SbxOBJECT )
SbxVOID toFront ( void )
SbxVOID toBack ( void )
SbxVOID setMenuBar ( SbxOBJECT )
SbxVOID setTitle ( SbxSTRING )
SbxSTRING getTitle ( void )
SbxINTEGER execute ( void ) ダイアログを実行させる
SbxVOID endExecute ( void ) ダイアログの実行を終了させる
SbxVOID changesOccurred ( SbxOBJECT )
SbxVOID modified ( SbxOBJECT )
SbxVOID windowResized ( SbxOBJECT )
SbxVOID windowMoved ( SbxOBJECT )
SbxVOID windowShown ( SbxOBJECT )
SbxVOID windowHidden ( SbxOBJECT )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxVOID setTabControllers ( SbxARRAY )
SbxARRAY getTabControllers ( void )
SbxVOID addTabController ( SbxOBJECT )
SbxVOID removeTabController ( SbxOBJECT )
SbxVOID setStatusText ( SbxSTRING )
SbxARRAY getControls ( void )
SbxOBJECT getControl ( SbxSTRING ) コントロールへの参照を返す
SbxVOID addControl ( SbxSTRING, SbxOBJECT )
SbxVOID removeControl ( SbxOBJECT )
SbxVOID addContainerListener ( SbxOBJECT )
SbxVOID removeContainerListener ( SbxOBJECT )
SbxOBJECT getElementType ( void )
SbxBOOL hasElements ( void )
SbxEMPTY getByIdentifier ( SbxLONG )
SbxARRAY getIdentifiers ( void )
SbxVOID replaceByIdentifer ( SbxLONG, SbxVARIANT )
SbxLONG insert ( SbxVARIANT )
SbxVOID removeByIdentifier ( SbxLONG )
SbxVOID dispose ( void )
SbxVOID addEventListener ( SbxOBJECT )
SbxVOID removeEventListener ( SbxOBJECT )
SbxVOID setContext ( SbxOBJECT )
SbxOBJECT getContext ( void )
SbxVOID createPeer ( SbxOBJECT, SbxOBJECT )
SbxOBJECT getPeer ( void )
SbxBOOL setModel ( SbxOBJECT )
SbxOBJECT getModel ( void )
SbxOBJECT getView ( void )
SbxVOID setDesignMode ( SbxBOOL )
SbxBOOL isDesignMode ( void )
SbxBOOL isTransparent ( void )
SbxVOID setPosSize ( SbxLONG, SbxLONG, SbxLONG, SbxLONG, SbxINTEGER )
SbxOBJECT getPosSize ( void )
SbxVOID setVisible ( SbxBOOL )
SbxVOID setEnable ( SbxBOOL )
SbxVOID setFocus ( void )
SbxVOID addWindowListener ( SbxOBJECT )
SbxVOID removeWindowListener ( SbxOBJECT )
SbxVOID addFocusListener ( SbxOBJECT )
SbxVOID removeFocusListener ( SbxOBJECT )
SbxVOID addKeyListener ( SbxOBJECT )
SbxVOID removeKeyListener ( SbxOBJECT )
SbxVOID addMouseListener ( SbxOBJECT )
SbxVOID removeMouseListener ( SbxOBJECT )
SbxVOID addMouseMotionListener ( SbxOBJECT )
SbxVOID removeMouseMotionListener ( SbxOBJECT )
SbxVOID addPaintListener ( SbxOBJECT )
SbxVOID removePaintListener ( SbxOBJECT )
SbxVOID setOutputSize ( SbxOBJECT )
SbxOBJECT getOutputSize ( void )
SbxBOOL isVisible ( void )
SbxBOOL isActive ( void )
SbxBOOL isEnabled ( void )
SbxBOOL hasFocus ( void )
SbxBOOL setGraphics ( SbxOBJECT )
SbxOBJECT getGraphics ( void )
SbxOBJECT getSize ( void )
SbxVOID draw ( SbxLONG, SbxLONG )
SbxVOID setZoom ( SbxSINGLE, SbxSINGLE )
SbxVOID propertiesChange ( SbxARRAY )
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxOBJECT getAccessibleContext ( void )
SbxVOID addModeChangeListener ( SbxOBJECT )
SbxVOID removeModeChangeListener ( SbxOBJECT )
SbxVOID addModeChangeApproveListener ( SbxOBJECT )
SbxVOID removeModeChangeApproveListener ( SbxOBJECT )
SbxOBJECT queryAdapter ( void )
SbxVOID setDelegator ( SbxOBJECT )
SbxEMPTY queryAggregation ( SbxOBJECT )

属性の詳細

ダイアログ・コントロールの属性
名前 種類
Menubar Object(配列)
Title String
Types Object(配列)
ImplemnetationId Integer(配列)
TabControllers Object(配列)
Controls Object(配列)
StatusText String
ElementType Object
Identifiers Long(配列)
Context Object
Peer Object
DesignMode Boolean
Visible Boolean
Enable Boolean
Graphics Object
ImplementationName String
SupportedServiceNames String(配列)
AccessibleContext com.sun.start.comp.toolkit.AccessibleDropDownListBox
Delegator Object

Model

stardiv.Toolkit.UnoControlDialogModel

View

stardiv.Toolkit.UnoDialogControl

PosSize

com.sun.star.awt.Rectangle

OutputSize

com.sun.star.awt.Size

Size

ダイアログの大きさ(幅と高さ)を表すcom.sun.star.awt.Sizeオブジェクト

Dbg_Properties

Dim Dbg_Properties As String

このオブジェクトが持つ属性(プロパティ)の一覧(各属性がセミコロン記号で区切られた文字列)

Dbg_Methods

Dim Dbg_Methods As String

このオブジェクトが持つメソッドの一覧(各メソッドがセミコロン記号で区切られた文字列)

メソッドの詳細

execute

ダイアログを実行させる

呼び出し形式
Function endExecute As Integer
引数

無し

戻り値
使用例
Dim oDialog As Object

BasicLibraries.LoadLibrary("Tools")
oDialog = LoadDialog("Standard", "MyDialog")
oDialog.execute
oDialog.endExecute

endExecute

ダイアログの実行を終了させる

呼び出し形式
Sub endExecute
引数

無し

戻り値

無し

使用例
Dim oDialog As Object

BasicLibraries.LoadLibrary("Tools")
oDialog = LoadDialog("Standard", "MyDialog")
oDialog.execute
oDialog.endExecute

getControl

コントロール・オブジェクトへの参照を返す

呼び出し形式
Function getControl( name As String) As Object
引数
name
コントロールの名前
戻り値

コントロール・オブジェクトへの参照を返す

使用例
Dim oDialog As Object
Dim oCheckBox As Object
Dim oDateField As Object
Dim oListBox As Object
Dim oNumericField As Object
Dim oRadioButton As Object

BasicLibraries.LoadLibrary("Tools")
oDialog = LoadDialog("Standard", "MyDialog")
oDialog.execute

oCheckBox     = oDialog.GetControl("CheckBox1")
oDateField    = oDialog.GetControl("DateField1")
oListBox      = oDialog.GetControl("ListBox1")
oNumericField = oDialog.GetControl("NumericField1")
oRadioButton  = oDialog.GetControl("OptionButton1")

stardiv.Toolkit.UnoListBoxControl

stardiv.Toolkit.UnoListBoxControlサービスは、ダイアログコントロールの一種であるリストボックスを表すオブジェクトです。

属性の概要

リストボックス(stardiv.Toolkit.UnoListBoxControlサービス) は、以下の属性をサポートしている。

stardiv.Toolkit.UnoListBoxControlの属性
属性 説明
SbxARRAY Types
SbxARRAY ImplementationId
SbxINTEGER ItemCount 項目の数(読み取り専用)
SbxARRAY Items
SbxINTEGER SelectedItemPos 強調表示中の項目の数(読み取り専用)
SbxARRAY SelectedItemsPos 強調表示中の項目の数を格納したデータフィールド(複数選択可能なリストボックスのみ。読み取り専用)
SbxSTRING SelectedItem 強調表示中の項目のテキスト(読み取り専用)
SbxARRAY SelectedItems 強調表示中の項目を格納したデータフィールド(読み取り専用)
SbxINTEGER DropDownLineCount
SbxBOOL MultipleMode 複数選択が許可されるか(True)、拒否されるか(False) の設定(この属性はIsMultipleMode を介した間接的な利用のみが可能)
SbxOBJECT MinimumSize
SbxOBJECT PreferredSize
SbxOBJECT Context
SbxOBJECT Peer
SbxOBJECT Model
SbxOBJECT View
SbxBOOL DesignMode
SbxOBJECT PosSize
SbxOBJECT OutputSize
SbxBOOL Visible
SbxBOOL Enable
SbxOBJECT Graphics
SbxOBJECT Size
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxOBJECT AccessibleContext
SbxOBJECT Delegator
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

メソッドの概要

stardiv.Toolkit.UnoListBoxControlのメソッド
メソッド 説明
SbxEMPTY queryInterface ( SbxOBJECT )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxVOID addItemListener ( SbxOBJECT )
SbxVOID removeItemListener ( SbxOBJECT )
SbxVOID addActionListener ( SbxOBJECT )
SbxVOID removeActionListener ( SbxOBJECT )
SbxVOID addItem ( SbxSTRING, SbxINTEGER ) 渡された文字列を指定するリスト位置に挿入する
SbxVOID addItems ( SbxARRAY, SbxINTEGER ) 文字列データフィールドの形で渡された複数の項目を指定するリスト位置に挿入する
SbxVOID removeItems ( SbxINTEGER, SbxINTEGER )
SbxINTEGER getItemCount ( void )
SbxSTRING getItem ( SbxINTEGER )
SbxARRAY getItems ( void )
SbxINTEGER getSelectedItemPos ( void )
SbxARRAY getSelectedItemsPos ( void )
SbxSTRING getSelectedItem ( void )
SbxARRAY getSelectedItems ( void )
SbxVOID selectItemPos ( SbxINTEGER, SbxBOOL )
SbxVOID selectItemsPos ( SbxARRAY, SbxBOOL )
SbxVOID selectItem ( SbxSTRING, SbxBOOL )
SbxBOOL isMutipleMode ( void ) リスト内で複数選択を許可するか否かを返す
SbxVOID setMultipleMode ( SbxBOOL )
SbxINTEGER getDropDownLineCount ( void )
SbxVOID setDropDownLineCount ( SbxINTEGER )
SbxVOID makeVisible ( SbxINTEGER )
SbxVOID disposing ( SbxOBJECT )
SbxVOID itemStateChanged ( SbxOBJECT )
SbxOBJECT getMinimumSize ( void )
SbxOBJECT getPreferredSize ( void )
SbxOBJECT calcAdjustedSize ( SbxOBJECT )
SbxOBJECT getMinimumSize ( SbxINTEGER, SbxINTEGER )
SbxVOID getColumnsAndLines ( SbxINTEGER, SbxINTEGER )
SbxVOID dispose ( void )
SbxVOID addEventListener ( SbxOBJECT )
SbxVOID removeEventListener ( SbxOBJECT )
SbxVOID setContext ( SbxOBJECT )
SbxOBJECT getContext ( void )
SbxVOID createPeer ( SbxOBJECT, SbxOBJECT )
SbxOBJECT getPeer ( void )
SbxBOOL setModel ( SbxOBJECT )
SbxOBJECT getModel ( void )
SbxOBJECT getView ( void )
SbxVOID setDesignMode ( SbxBOOL )
SbxBOOL isDesignMode ( void )
SbxBOOL isTransparent ( void )
SbxVOID setPosSize ( SbxLONG, SbxLONG, SbxLONG, SbxLONG, SbxINTEGER )
SbxOBJECT getPosSize ( void )
SbxVOID setVisible ( SbxBOOL )
SbxVOID setEnable ( SbxBOOL ) コントロールの有効・無効を切り替える
SbxVOID setFocus ( void )
SbxVOID addWindowListener ( SbxOBJECT )
SbxVOID removeWindowListener ( SbxOBJECT )
SbxVOID addFocusListener ( SbxOBJECT )
SbxVOID removeFocusListener ( SbxOBJECT )
SbxVOID addKeyListener ( SbxOBJECT )
SbxVOID removeKeyListener ( SbxOBJECT )
SbxVOID addMouseListener ( SbxOBJECT )
SbxVOID removeMouseListener ( SbxOBJECT )
SbxVOID addMouseMotionListener ( SbxOBJECT )
SbxVOID removeMouseMotionListener ( SbxOBJECT )
SbxVOID addPaintListener ( SbxOBJECT )
SbxVOID removePaintListener ( SbxOBJECT )
SbxVOID setOutputSize ( SbxOBJECT )
SbxOBJECT getOutputSize ( void )
SbxBOOL isVisible ( void )
SbxBOOL isActive ( void )
SbxBOOL isEnabled ( void ) コントロールの有効・無効を返す
SbxBOOL hasFocus ( void )
SbxBOOL setGraphics ( SbxOBJECT )
SbxOBJECT getGraphics ( void )
SbxOBJECT getSize ( void )
SbxVOID draw ( SbxLONG, SbxLONG )
SbxVOID setZoom ( SbxSINGLE, SbxSINGLE )
SbxVOID propertiesChange ( SbxARRAY )
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxOBJECT getAccessibleContext ( void )
SbxVOID addModeChangeListener ( SbxOBJECT )
SbxVOID removeModeChangeListener ( SbxOBJECT )
SbxVOID addModeChangeApproveListener ( SbxOBJECT )
SbxVOID removeModeChangeApproveListener ( SbxOBJECT )
SbxOBJECT queryAdapter ( void )
SbxVOID setDelegator ( SbxOBJECT )
SbxEMPTY queryAggregation ( SbxOBJECT )

属性の詳細

SelectedItem

選択されている項目を表すString型の値(文字列)

使用例
Dim oDialog As Object

BasicLibraries.LoadLibrary("Tools")
oDialog = LoadDialog("Standard", "MyDialog")
oDialog.execute()

If oDialog.GetControl("ListBox1").SelectedItem = "Bollinger bands" Then
  REM
Else
  REM
End If

メソッドの詳細

addItem

文字列を指定するリスト位置に挿入する。

呼び出し形式
Sub addItem( Item As String, Pos As Integer)
引数
Item
リストボックスに挿入する文字列
Pos
挿入するリスト位置
戻り値

無し

setEnable

リストボックスの有効・無効を切り替える。無効にしたコントロールは淡色(灰色)表示となり、入力や選択が行えなくなる。

リストボックスが有効か無効かを判定するには、isEnabledメソッドを使用する。

呼び出し形式
Sub setEnable( flag As Boolean)
引数
flag
リストボックスを有効するか無効にするかを指定するフラグ。有効する場合はTrue、無効にする場合はFalse。
戻り値

無し

isEnabled

リストボックスが有効か無効かを表すBoolean値を返す。

リストボックスの有効・無効を切り替えるには、setEnableメソッドを使用する。

呼び出し形式
Function setEnable As Boolean
引数

無し

戻り値

リストボックスが有効か無効かを表すBoolean値。有効ならTrue、無効ならFalse。

stardiv.Toolkit.UnoNumericFieldControl

UnoNumericFieldControlクラスは数値フィールドを表すクラスである。

プロパティの概要

stardiv.Toolkit.UnoNumericFieldControlのプロパティ
プロパティ 説明
SbxARRAY Types
SbxARRAY ImplementationId
SbxDOUBLE Value 数値フィールドに入力された値
SbxDOUBLE Min
SbxDOUBLE Max
SbxDOUBLE First
SbxDOUBLE Last
SbxDOUBLE SpinSize
SbxINTEGER DecimalDigits
SbxBOOL StrictFormat
SbxOBJECT Context
SbxOBJECT Peer
SbxOBJECT Model
SbxOBJECT View
SbxBOOL DesignMode
SbxOBJECT PosSize
SbxOBJECT OutputSize
SbxBOOL Visible
SbxBOOL Enable
SbxOBJECT Graphics
SbxOBJECT Size
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxOBJECT AccessibleContext
SbxOBJECT Delegator
SbxSTRING Text
SbxSTRING SelectedText
SbxOBJECT Selection
SbxINTEGER MaxTextLen
SbxBOOL Editable
SbxOBJECT MinimumSize
SbxOBJECT PreferredSize
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

メソッドの概要

stardiv.Toolkit.UnoNumericFieldControlのメソッド
メソッド 説明
SbxEMPTY queryInterface ( SbxOBJECT )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxVOID setValue ( SbxDOUBLE )
SbxDOUBLE getValue ( void )
SbxVOID setMin ( SbxDOUBLE )
SbxDOUBLE getMin ( void )
SbxVOID setMax ( SbxDOUBLE )
SbxDOUBLE getMax ( void )
SbxVOID setFirst ( SbxDOUBLE )
SbxDOUBLE getFirst ( void )
SbxVOID setLast ( SbxDOUBLE )
SbxDOUBLE getLast ( void )
SbxVOID setSpinSize ( SbxDOUBLE )
SbxDOUBLE getSpinSize ( void )
SbxVOID setDecimalDigits ( SbxINTEGER )
SbxINTEGER getDecimalDigits ( void )
SbxVOID setStrictFormat ( SbxBOOL )
SbxBOOL isStrictFormat ( void )
SbxVOID addSpinListener ( SbxOBJECT )
SbxVOID removeSpinListener ( SbxOBJECT )
SbxVOID up ( void )
SbxVOID down ( void )
SbxVOID first ( void )
SbxVOID last ( void )
SbxVOID enableRepeat ( SbxBOOL )
SbxVOID dispose ( void )
SbxVOID addEventListener ( SbxOBJECT )
SbxVOID removeEventListener ( SbxOBJECT )
SbxVOID setContext ( SbxOBJECT )
SbxOBJECT getContext ( void )
SbxVOID createPeer ( SbxOBJECT, SbxOBJECT )
SbxOBJECT getPeer ( void )
SbxBOOL setModel ( SbxOBJECT )
SbxOBJECT getModel ( void )
SbxOBJECT getView ( void )
SbxVOID setDesignMode ( SbxBOOL )
SbxBOOL isDesignMode ( void )
SbxBOOL isTransparent ( void )
SbxVOID setPosSize ( SbxLONG, SbxLONG, SbxLONG, SbxLONG, SbxINTEGER )
SbxOBJECT getPosSize ( void )
SbxVOID setVisible ( SbxBOOL )
SbxVOID setEnable ( SbxBOOL ) コントロールの有効・無効を切り替える
SbxVOID setFocus ( void )
SbxVOID addWindowListener ( SbxOBJECT )
SbxVOID removeWindowListener ( SbxOBJECT )
SbxVOID addFocusListener ( SbxOBJECT )
SbxVOID removeFocusListener ( SbxOBJECT )
SbxVOID addKeyListener ( SbxOBJECT )
SbxVOID removeKeyListener ( SbxOBJECT )
SbxVOID addMouseListener ( SbxOBJECT )
SbxVOID removeMouseListener ( SbxOBJECT )
SbxVOID addMouseMotionListener ( SbxOBJECT )
SbxVOID removeMouseMotionListener ( SbxOBJECT )
SbxVOID addPaintListener ( SbxOBJECT )
SbxVOID removePaintListener ( SbxOBJECT )
SbxVOID setOutputSize ( SbxOBJECT )
SbxOBJECT getOutputSize ( void )
SbxBOOL isVisible ( void )
SbxBOOL isActive ( void )
SbxBOOL isEnabled ( void ) コントロールの有効・無効を返す
SbxBOOL hasFocus ( void )
SbxBOOL setGraphics ( SbxOBJECT )
SbxOBJECT getGraphics ( void )
SbxOBJECT getSize ( void )
SbxVOID draw ( SbxLONG, SbxLONG )
SbxVOID setZoom ( SbxSINGLE, SbxSINGLE )
SbxVOID disposing ( SbxOBJECT )
SbxVOID propertiesChange ( SbxARRAY )
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxOBJECT getAccessibleContext ( void )
SbxVOID addModeChangeListener ( SbxOBJECT )
SbxVOID removeModeChangeListener ( SbxOBJECT )
SbxVOID addModeChangeApproveListener ( SbxOBJECT )
SbxVOID removeModeChangeApproveListener ( SbxOBJECT )
SbxOBJECT queryAdapter ( void )
SbxVOID setDelegator ( SbxOBJECT )
SbxEMPTY queryAggregation ( SbxOBJECT )
SbxVOID addTextListener ( SbxOBJECT )
SbxVOID removeTextListener ( SbxOBJECT )
SbxVOID setText ( SbxSTRING )
SbxVOID insertText ( SbxOBJECT, SbxSTRING )
SbxSTRING getText ( void )
SbxSTRING getSelectedText ( void )
SbxVOID setSelection ( SbxOBJECT )
SbxOBJECT getSelection ( void )
SbxBOOL isEditable ( void )
SbxVOID setEditable ( SbxBOOL )
SbxVOID setMaxTextLen ( SbxINTEGER )
SbxINTEGER getMaxTextLen ( void )
SbxVOID textChanged ( SbxOBJECT )
SbxOBJECT getMinimumSize ( void )
SbxOBJECT getPreferredSize ( void )
SbxOBJECT calcAdjustedSize ( SbxOBJECT )
SbxOBJECT getMinimumSize ( SbxINTEGER, SbxINTEGER )
SbxVOID getColumnsAndLines ( SbxINTEGER, SbxINTEGER )

プロパティの詳細

Value

数値フィールドに入力された数値(Double型の値)

メソッドの詳細

setEnable

数値フィールドの有効・無効を切り替える。無効にしたコントロールは淡色(灰色)表示となり、入力や選択が行えなくなる。

数値フィールドが有効か無効かを判定するには、isEnabledメソッドを使用する。

呼び出し形式
Sub setEnable( flag As Boolean)
引数
flag
数値フィールドを有効するか無効にするかを指定するフラグ。有効する場合はTrue、無効にする場合はFalse。
戻り値

無し

isEnabled

数値フィールドが有効か無効かを表すBoolean値を返す。

数値フィールドの有効・無効を切り替えるには、setEnableメソッドを使用する。

呼び出し形式
Function setEnable As Boolean
引数

無し

戻り値

数値フィールドが有効か無効かを表すBoolean値。有効ならTrue、無効ならFalse。

stardiv.Toolkit.UnoRadioButtonControl

UnoRadioButtonControlは、ダイアログコントロールの一種であるオプションボタン(ラジオボタン)を表すオブジェクトである。

複数のボタンをグループ化して、そのうち1つのオプションを選択することにより使用する。その際にオプションの1つが選択されると、残りのオプションは非選択状態になる。このように処理することで、選択状態にあるオプションは常に1つだけになる。

属性の概要

stardiv.Toolkit.UnoRadioButtonControlの属性
属性 説明
SbxSTRING Label ボタンに表示するラベル(タイトル)
SbxSTRING ActionCommand
SbxBOOL State ボタンの状態
SbxOBJECT MinimumSize
SbxOBJECT PreferredSize
SbxARRAY Types
SbxARRAY ImplementationId
SbxOBJECT Context
SbxOBJECT Peer
SbxOBJECT Model
SbxOBJECT View
SbxBOOL DesignMode
SbxOBJECT PosSize
SbxOBJECT OutputSize
SbxBOOL Visible
SbxBOOL Enable
SbxOBJECT Graphics
SbxOBJECT Size
SbxSTRING ImplementationName
SbxARRAY SupportedServiceNames
SbxOBJECT AccessibleContext
SbxOBJECT Delegator
SbxSTRING Dbg_SupportedInterfaces サポートしているインタフェースの一覧
SbxSTRING Dbg_Properties 属性の一覧
SbxSTRING Dbg_Methods メソッドの一覧

メソッドの概要

stardiv.Toolkit.UnoRadioButtonControlのメソッド
メソッド 説明
SbxEMPTY queryInterface ( SbxOBJECT )
SbxVOID addActionListener ( SbxOBJECT )
SbxVOID removeActionListener ( SbxOBJECT )
SbxVOID setLabel ( SbxSTRING )
SbxVOID setActionCommand ( SbxSTRING )
SbxVOID addItemListener ( SbxOBJECT )
SbxVOID removeItemListener ( SbxOBJECT )
SbxBOOL getState ( void )
SbxVOID setState ( SbxBOOL )
SbxVOID setLabel ( SbxSTRING )
SbxVOID disposing ( SbxOBJECT )
SbxVOID itemStateChanged ( SbxOBJECT )
SbxOBJECT getMinimumSize ( void )
SbxOBJECT getPreferredSize ( void )
SbxOBJECT calcAdjustedSize ( SbxOBJECT )
SbxARRAY getTypes ( void )
SbxARRAY getImplementationId ( void )
SbxVOID dispose ( void )
SbxVOID addEventListener ( SbxOBJECT )
SbxVOID removeEventListener ( SbxOBJECT )
SbxVOID setContext ( SbxOBJECT )
SbxOBJECT getContext ( void )
SbxVOID createPeer ( SbxOBJECT, SbxOBJECT )
SbxOBJECT getPeer ( void )
SbxBOOL setModel ( SbxOBJECT )
SbxOBJECT getModel ( void )
SbxOBJECT getView ( void )
SbxVOID setDesignMode ( SbxBOOL )
SbxBOOL isDesignMode ( void )
SbxBOOL isTransparent ( void )
SbxVOID setPosSize ( SbxLONG, SbxLONG, SbxLONG, SbxLONG, SbxINTEGER )
SbxOBJECT getPosSize ( void )
SbxVOID setVisible ( SbxBOOL )
SbxVOID setEnable ( SbxBOOL ) コントロールの有効・無効を切り替える
SbxVOID setFocus ( void )
SbxVOID addWindowListener ( SbxOBJECT )
SbxVOID removeWindowListener ( SbxOBJECT )
SbxVOID addFocusListener ( SbxOBJECT )
SbxVOID removeFocusListener ( SbxOBJECT )
SbxVOID addKeyListener ( SbxOBJECT )
SbxVOID removeKeyListener ( SbxOBJECT )
SbxVOID addMouseListener ( SbxOBJECT )
SbxVOID removeMouseListener ( SbxOBJECT )
SbxVOID addMouseMotionListener ( SbxOBJECT )
SbxVOID removeMouseMotionListener ( SbxOBJECT )
SbxVOID addPaintListener ( SbxOBJECT )
SbxVOID removePaintListener ( SbxOBJECT )
SbxVOID setOutputSize ( SbxOBJECT )
SbxOBJECT getOutputSize ( void )
SbxBOOL isVisible ( void )
SbxBOOL isActive ( void )
SbxBOOL isEnabled ( void ) コントロールの有効・無効を返す
SbxBOOL hasFocus ( void )
SbxBOOL setGraphics ( SbxOBJECT )
SbxOBJECT getGraphics ( void )
SbxOBJECT getSize ( void )
SbxVOID draw ( SbxLONG, SbxLONG )
SbxVOID setZoom ( SbxSINGLE, SbxSINGLE )
SbxVOID propertiesChange ( SbxARRAY )
SbxSTRING getImplementationName ( void )
SbxBOOL supportsService ( SbxSTRING )
SbxARRAY getSupportedServiceNames ( void )
SbxOBJECT getAccessibleContext ( void )
SbxVOID addModeChangeListener ( SbxOBJECT )
SbxVOID removeModeChangeListener ( SbxOBJECT )
SbxVOID addModeChangeApproveListener ( SbxOBJECT )
SbxVOID removeModeChangeApproveListener ( SbxOBJECT )
SbxOBJECT queryAdapter ( void )
SbxVOID setDelegator ( SbxOBJECT )
SbxEMPTY queryAggregation ( SbxOBJECT )

属性の詳細

State

ボタンの状態を表すBoolean型の値

State
説明
True 選択されている
False 選択されていない
使用例
Dim oDialog As Object
Dim oOptionButton As Object

BasicLibraries.LoadLibrary("Tools")
oDialog = LoadDialog("Standard", "Dialog1")
oDialog.Execute()

oOptionButton = oDialog.GetControl("OptionButton1")
If oOptionButton.State = True Then
  ' ボタンが選択されているときの処理
Else
  ' ボタンが選択されていない時の処理
End If

メソッドの詳細

setEnable

ラジオボタンの有効・無効を切り替える。無効にしたコントロールは淡色(灰色)表示となり、入力や選択が行えなくなる。

ラジオボタンが有効か無効かを判定するには、isEnabledメソッドを使用する。

呼び出し形式
Sub setEnable( flag As Boolean)
引数
flag
ラジオボタンを有効するか無効にするかを指定するフラグ。有効する場合はTrue、無効にする場合はFalse。
戻り値

無し

isEnabled

ラジオボタンが有効か無効かを表すBoolean値を返す。

ラジオボタンの有効・無効を切り替えるには、setEnableメソッドを使用する。

呼び出し形式
Function setEnable As Boolean
引数

無し

戻り値

ラジオボタンが有効か無効かを表すBoolean値。有効ならTrue、無効ならFalse。