Apache OpenOffice Wiki - User contributions [en]

G11ntest/Documentation/BASIC Guide/

2009-10-21T14:45:05Z

G11nAutomation:

= 英语 =

= 德语 =

[[Category:G11n Wiki Translation]]

G11ntest/Documentation/BASIC Guide/Boolean

2009-10-21T14:45:00Z

G11nAutomation:

{{DISPLAYTITLE:布尔变量}}
{{Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Numbers
|NextPage=Documentation/BASIC Guide/Date
|lang=block
}}

<tt>True</tt><tt>False</tt>They are suitable for binary specifications that can only adopt one of two statuses. A Boolean value is saved internally as a two-byte integer value, where 0 corresponds to the False and any other value to True. There is no type declaration symbol for Boolean variables. <tt>As Boolean</tt>

Example declaration of a Boolean variable:

<source lang="oobas">
Dim Variable As Boolean
</source>

{{InterWiki Languages BasicGuide|articletitle=}}
{{PDL1}}

[[Category:G11n Wiki Translation]]

G11ntest/Documentation/BASIC Guide/Arrays

2009-10-21T14:44:54Z

G11nAutomation:

{{Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Date
|NextPage=Documentation/BASIC Guide/Scope of Variables
|lang=block
}}
{{DISPLAYTITLE:Arrays}}

{{OOo}}

==

====

<source lang="oobas">
Dim MyArray(3)
</source>

<tt>MyArray(0)</tt><tt>MyArray(1)</tt><tt>MyArray(2)</tt><tt>MyArray(3)</tt>

<source lang="oobas">
Dim MyInteger(3) As Integer
</source>

<source lang="oobas">
Dim MyInteger(5 To 10) As Integer
</source>

<source lang="oobas">
Dim MyInteger(-10 To -5) As Integer
</source>

<source lang="oobas">
Dim s(-53000 to 89000) As String
s(-52000) = "aa"
s(79999) = "bb"
print s(-52000), s(79999)
</source>

{{Documentation/Note|}}

====

<source lang="oobas">
Option Base 1
</source>

{{OOo}}

<tt>Option Base 1</tt>

<source lang="oobas">
Option Base 1
' ...
Dim MyInteger(3)
</source>

<tt>MyInteger(1)</tt><tt>MyInteger(2)</tt><tt>MyInteger(3)</tt><tt>MyInteger(4)</tt>

{{Documentation/Note|{{OOo}}<tt>Option Base 1</tt>{{OOo}}<tt>MyInteger(3)</tt>{{OOo}}<tt>Option Compatible</tt>{{OOo}}}}

====

{{OOo}}

<source lang="oobas">
Dim MyIntArray(5, 5) As Integer
</source>

=

{{OOo}}

====

{{OOo}}

<source lang="oobas">
ReDim MyArray(10)
</source>

{{Documentation/Note|<tt>Dim MyArray()</tt>{{OOo}}<tt>ReDim</tt>}}

<source lang="oobas">
Dim MyArray(4) As Integer ' Declaration with five elements
' ...
ReDim MyArray(10) As Integer ' Increase to 11 elements
' ...
ReDim MyArray(20) As Integer ' Increase to 21 elements
</source>

<tt>Preserve</tt>

<source lang="oobas">
Dim MyArray(10) As Integer ' Defining the initial
' dimensions
' ...
ReDim Preserve MyArray(20) As Integer ' Increase in
' data field, while
' retaining content
</source>

<tt>Preserve</tt>

{{Documentation/Note|<tt>Preserve</tt>{{OOo}}}}

<tt>ReDim</tt><tt>Preserve</tt>

====

<source lang="oobas">
Dim MyArray(10) As Integer
' ... some instructions
Dim n As Integer
n = 47 ' could be the result of a computation
Redim MyArray(n) As Integer
MsgBox(LBound(MyArray)) ' displays : 0
MsgBox(UBound(MyArray)) ' displays : 47
</source>

<source lang="oobas">
Dim MyArray(10, 13 to 28) As Integer
MsgBox(LBound(MyArray, 2)) ' displays : 13
MsgBox(UBound(MyArray, 2)) ' displays : 28
</source>

====

<source lang="oobas">
Dim s() As String ' declare an empty array
' --- later in the program ...
Redim s(13) As String
</source>

<source lang="oobas">
Dim MyArray() As Integer
MsgBox(LBound(MyArray)) ' displays : 0
MsgBox(UBound(MyArray)) ' displays : -1
</source>

==

=

==

==

=

{{InterWiki Languages BasicGuide|articletitle=}}
{{PDL1}}

[[Category:G11n Wiki Translation]]

G11ntest/Documentation/BASIC Guide/API Intro

2009-10-21T14:44:47Z

G11nAutomation:

{{Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Other Functions (Runtime Library)
|NextPage=Documentation/BASIC Guide/UNO
|api=block
}}
{{DISPLAYTITLE:{{OOo}}}}

{{OOo}}{{OOo}}{{OOo}}{{OOo}}''''''

{{OOo}}

{{InterWiki Languages BasicGuide|articletitle=}}
{{PDL1}}

[[Category:G11n Wiki Translation]]

G11ntest/Documentation/BASIC Guide/Branching

2009-10-21T14:44:39Z

G11nAutomation:

{{DISPLAYTITLE:Branching}}
{{Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Operators
|NextPage=Documentation/BASIC Guide/Loops
|lang=block
}}

使用分支语句可以限制执行代码块,直到特定条件满足。

== <tt>If...Then...Else</tt> ==

最常用的分支语句是 <tt>If</tt> 语句中所示:

<source lang="oobas">
If A > 3 Then
B = 2
End If
</source>

} <tt>B = 2</tt> 指定仅发生在变量 <tt>A</tt> 大于3。的变体 <tt>If</tt> 语句是 <tt>If/Else</tt> 子句:

<source lang="oobas">
If A > 3 Then
B = 2
Else
B = 0
End If
</source>

在本例中,变量 <tt>B</tt> 的值被指定为2时 <tt>A</tt> 大于3,否则 <tt>B</tt> 的值被指定为0。

对于更复杂语句,可以级联的 <tt>If</tt> 语句,例如:

<source lang="oobas">
If A = 0 Then
B = 0
ElseIf A < 3 Then
B = 1
Else
B = 2
End If
</source>

如果该值的变量 <tt>A</tt> 等于零, <tt>B</tt> 的值指定为0。如果 <tt>A</tt> 小于3(但不等于0),则 <tt>B</tt> 的值指定为1。在所有其他情况下(也就是说,如果 <tt>A</tt> 大于或等于3) <tt>B</tt> 的值指定为2。

一个全面,声明可写在单一行,并使用一种简单语法。第一个例子此页面可以写成:

<source lang="oobas">
If A > 3 Then B = 2
</source>
第二个示例,此页面可以写成:
<source lang="oobas">
If A > 3 Then B = 2 Else B = 0
</source>

== <tt>Select...Case</tt> ==

该 <tt>Select...Case</tt> 指令可替代级联 <tt>If</tt> 语句,它用于需要来检查某个值按照各种条件:

<source lang="oobas">
Select Case DayOfWeek
Case 1:
NameOfWeekday = "Sunday"
Case 2:
NameOfWeekday = "Monday"
Case 3:
NameOfWeekday = "Tuesday"
Case 4:
NameOfWeekday = "Wednesday"
Case 5:
NameOfWeekday = "Thursday"
Case 6:
NameOfWeekday = "Friday"
Case 7:
NameOfWeekday = "Saturday"
End Select
</source>

在本示例中,名称工作日都对应一个数字,因此,该 <tt>DayOfWeek</tt> 变量的值指定为1用于 <tt>Sunday</tt>,2代表 <tt>Monday</tt> 值,并依次类推。

此 <tt>Select</tt> 命令不限于简单的1:1赋值,也可以指定比较运算符或表达式列单的 <tt>Case</tt> 分支。以下示例列出最重要的语法变体:

<source lang="oobas">
Select Case Var
Case 1 To 5
' ... Var is between the numbers 1 and 5 (including the values 1 and 5).
Case > 100
' ... Var is greater than 100
Case 6, 7, 8
' ... Var is 6, 7 or 8
Case 6, 7, 8, > 15, < 0
' ... Var is 6, 7, 8, greater than 15, or less than 0
Case Else
' ... all other instances
End Select
</source>

现在请考虑不正确(高级)和生成常见的错误:

<source lang="oobas">
Select Case Var
Case Var = 8
' ... Var is 0
Case Else
' ... all other instances
End Select
</source>

说明(Var = 8)计算为true var8,否则为False。为true,-1和设置为false,0。 "Select Case语句的求值的表达式,它是True或False,然后比较的值设置为var。当var0,则匹配。如果您知道最后一个示例,则您还知道为何本示例不做它显示

<source lang="oobas">
Select Case Var
Case Var > 8 And Var < 11
' ... Var is 0
Case Else
' ... all other instances
End Select
</source>

{{InterWiki Languages BasicGuide|articletitle=}}
{{PDL1}}

[[Category:G11n Wiki Translation]]

G11ntest/Documentation/BASIC Guide

2009-10-21T14:44:32Z

G11nAutomation:

{{Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=none
|NextPage=Documentation/BASIC Guide/Language
}}
{{DISPLAYTITLE:{{OOo}}}}

{{Download_Collection|MediaWiki:Collections/BASIC_Guide}}

中文 This guide provides an introduction to programming with {{OOo}} Basic. 中文 To get the most out of this book, you should be familiar with other programming languages. 中文 Extensive examples are provided to help you quickly develop your own {{OOo}} Basic programs.

中文 This guide divides information about {{OOo}} administration into several chapters. 中文 The first three chapters introduce you to {{OOo}} Basic:

* [[Documentation/BASIC Guide/Language|多语言{{OOo}} Basic]]
* [[Documentation/BASIC Guide/Runtime_Library|Runtime Library中文]]
* [[Documentation/BASIC Guide/API_Intro|介绍 API]]

中文 These chapters provide an overview of {{OOo}} Basic and should be read by anyone who intends to write {{OOo}} Basic programs. 中文 The remaining chapters describe the individual components of the {{OOo}} API in more detail and can be read selectively as required:

* [[Documentation/BASIC Guide/Documents|参照文档工作]]
* [[Documentation/BASIC Guide/Text Documents|文本文档]]
* [[Documentation/BASIC Guide/Spreadsheets|数据表文档]]
* [[Documentation/BASIC Guide/Drawings Presentations|绘图和演示]]
* [[Documentation/BASIC Guide/Charts|Charts (Diagrams)]]
* [[Documentation/BASIC Guide/Database|数据库]]
* [[Documentation/BASIC Guide/Dialogs|Dialogs]]
* [[Documentation/BASIC Guide/Forms|Forms]]

=={{OOo}}==

中文测试The {{OOo}} Basic programming language has been developed especially for {{OOo}} and is firmly integrated in the Office package.

中文 As the name suggests, {{OOo}} Basic is a programming language from the Basic family. Anyone who has previously worked with other Basic languages — in particular with Visual Basic or Visual Basic for Applications (VBA) from Microsoft — will quickly become accustomed to {{OOo}} Basic. Large sections of the basic constructs of {{OOo}} Basic are compatible with Visual Basic.

The {{OOo}} Basic programming language can be divided into four components:

* The language of {{OOo}} Basic: Defines the elementary linguistic constructs, for example, for variable declarations, loops, and functions.
* The runtime library: Provides standard functions which have no direct reference to {{OOo}}, for example, functions for editing numbers, strings, date values, and files.
* The {{OOo}} API (Application Programming Interface): Permits access to {{OOo}} documents and allows these to be created, saved, modified, and printed.
* The Dialog Editor: Creates personal dialog windows and provides scope for the adding of control elements and event handlers.

{{Documentation/Note|{{OOo}}{{OOo}}{{OOo}}{{OOo}}}}

=={{OOo}}==

The scope of application for {{OOo}} Basic begins where the standard functions of {{OOo}} end. Routine tasks can therefore be automated in {{OOo}} Basic, links can be made to other programs — for example to a database server — and complex activities can be performed at the press of a button by using predefined scripts.

{{OOo}} Basic offers complete access to all {{OOo}} functions, supports all functions, modifies document types, and provides options for creating personal dialog windows.

=={{OOo}}==

{{OOo}} Basic can be used by any {{OOo}} user without any additional programs or aids. Even in the standard installation, {{OOo}} Basic has all the components needed to create its own Basic macros, including:

* The integrated development environment (IDE) which provides an editor for creating and testing macros.
* The interpreter, which is needed to run {{OOo}} Basic macros.
* The interfaces to various {{OOo}} applications, which allow for direct access to Office documents.

====

The components of the {{OOo}} API that are discussed in this guide were selected based on their practical benefits for the {{OOo}} Basic programmer. In general, only parts of the interfaces are discussed. 有关详细图像,请参见 [http://api.openoffice.org/docs/common/ref/com/sun/star/module-ix.html 《API参考]。

[[Documentation/DevGuide/OpenOffice.org_Developers_Guide|Documentation/DevGuide/OpenOffice.org_Developers_Guide]]{{OOo}}Anyone who is already familiar with {{OOo}} Basic programming can find additional information in the Developer's Guide on {{OOo}} Basic and {{OOo}} programming.

{{OOo}}{{OOo}}{{OOo}}{{OOo}}

{{InterWiki Languages BasicGuide|articletitle=}}
{{PDL1}}

[[Category:G11n Wiki Translation]]

Ja/Documentation/DevGuide/AppendixB/Special Markups

2009-10-13T14:36:51Z

G11nAutomation: Created page with '{{Documentation/DevGuide/AppendixBTOC |ShowPrevNext=block |PrevPage=Documentation/DevGuide/AppendixB/Element Documentation |NextPage=Documentation/DevGuide/AppendixB/Special Docu…'

{{Documentation/DevGuide/AppendixBTOC
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/AppendixB/Element Documentation
|NextPage=Documentation/DevGuide/AppendixB/Special Documentation Tags
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/AppendixB/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:特殊なマークアップ}}
__NOTOC__
これらのマークアップタグは、ドキュメンテーションのレイアウトバージョン (HTML または XHTML) を生成する XSL プロセッサによって評価されます。これらのタグは、記述に間違いがなく、開始タグと終了タグがペアになっていて、大文字小文字も正しく記載されている必要があります。

クロスリファレンステーブルを構築したり、整合性をチェックする際に生成されたドキュメンテーションの識別子を強調し、ハイパーリンクを自動的に生成するには、すべての識別子をマークアップする必要があります。さらに、単独の語で構成されるメソッド名は動詞で区別できないので、校正にも重要になります。識別子は、編集者による再編集から除外する必要があります。

使用されるマークアップは以下のとおりです。

=== <nowiki><atom></nowiki> ===

このマークアップは、long、short、string などの atomar タイプの識別子で使用されます。タイプのシーケンスやアレイが参照される場合は、次元数を表すかっこのペア数とともに属性 dim を追加します。

これは下記のように利用します。

<nowiki><atom>long</atom></nowiki>

シーケンスの例については、<nowiki><type></nowiki> を参照してください。

=== <nowiki><type></nowiki> ===

このマークアップは、インタフェース、サービス、typedef、struct、例外、enum、および定数グループの識別子に使用されます。タイプのシーケンスやアレイが参照される場合は、次元数を表すかっこのペア数とともに属性 dim を追加します。

これは下記のように利用します。

<nowiki>type scope="com::sun::star::uno">XInterface</type>
<type dim="[][]">PropertyValue</type></nowiki>

=== <nowiki><member></nowiki> ===

このマークアップは、推奨されないメソッド、フィールド、および属性マークアップを置換し、struct と例外のフィールド、およびサービス仕様の属性やインターフェースのメソッドで使用されます。

これは下記のように利用します。

<nowiki><member scope="com::sun::star::uno">XInterface::queryInterface()</member></nowiki>

=== <nowiki><const></nowiki> ===

このマークアップは、定数グループや enum の記号定数の識別子で使用されます。

これは下記のように利用します。

<nowiki><const scope="...">ParagraphAdjust::LEFT</const></nowiki>

=== <nowiki><TRUE/>, <FALSE/></nowiki> ===

これらのマークアップは、Boolean 値 TRUE および FALSE の原子的な定数を表します。

これは下記のように利用します。

@returns
<nowiki>数値が有効な場合は <TRUE\>、そうでない場合は <FALSE\>。</nowiki>

=== <nowiki><NULL/></nowiki> ===

このマークアップは、NULL 値の原子的な定数を表します。

=== <nowiki><void/></nowiki> ===

このマークアップは、原子的なタイプ void を表します。これは、<nowiki><atom>void</atom></nowiki> と同じです。

=== <nowiki><code></nowiki> ===

このマークアップは、インラインコードで使用されます。

これは下記のように利用します。

Use <nowiki><code>queryInterface( NULL )</code></nowiki> for:

<nowiki>listing>
このマークアップは、複数行のコードの例で使用されます。
これは下記のように利用します。
@example StarBASIC
<listing>
aCmp = StarDesktop.loadComponentFromURL( ... )
if ( isnull(aCmp) )
....
endif
</listing></nowiki>

{{PDL1}}

[[Category:Documentation/Developer's Guide/Appendix]]

[[Category:G11n Wiki Translation]]

Ja/Documentation/DevGuide/Basic/First Steps with OpenOffice.org Basic

2009-10-13T14:36:47Z

G11nAutomation: Created page with '{{Documentation/DevGuide/BasicTOC |BasicTutorial=block |ShowPrevNext=block |PrevPage=Documentation/DevGuide/Basic/OpenOffice.org Basic |NextPage=Documentation/DevGuide/Basic/Crea…'

{{Documentation/DevGuide/BasicTOC
|BasicTutorial=block
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/Basic/OpenOffice.org Basic
|NextPage=Documentation/DevGuide/Basic/Creating a Module in a Standard Library
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/Basic/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:{{PRODUCTNAME}} Basic 入門}}
=== 手順に沿ったチュートリアル ===
この節は、Basic IDE を使用できるようになるための開発者用のチュートリアルです。この節では、Basic IDE でプログラムを作成およびデバッグして、Basic ダイアログを設計するために必要な手順を説明します。すべてのツールおよびオプションの包括的な説明については、 [[Documentation/DevGuide/Basic/OpenOffice.org Basic IDE|OpenOffice.org Basic IDE]] を参照してください。

{{PDL1}}

[[Category:Documentation/Developer's Guide/Basic and Dialogs]]

[[Category:G11n Wiki Translation]]

Ja/Documentation/DevGuide/AppendixA/Source Files and Types

2009-10-13T14:35:11Z

G11nAutomation: Created page with '{{Documentation/DevGuide/AppendixATOC |ShowPrevNext=block |PrevPage=Documentation/DevGuide/AppendixA/Abbreviations |NextPage=Documentation/DevGuide/AppendixB/IDL Documentation Gu…'

{{Documentation/DevGuide/AppendixATOC
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/AppendixA/Abbreviations
|NextPage=Documentation/DevGuide/AppendixB/IDL Documentation Guidelines
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/AppendixA/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:ソースファイルとタイプ}}
各タイプに対し、同じベース名と拡張子 ''.idl'' を持つ個別の IDL ファイルを作成します。

{{PDL1}}

[[Category:Documentation/Developer's Guide/Appendix]]

[[Category:G11n Wiki Translation]]

Ja/Documentation/DevGuide/JavaBean/OfficeConnection Interface

2009-10-09T12:15:50Z

G11nAutomation: Created page with '{{Documentation/DevGuide/JavaBeanTOC |JavaBean2b=block |ShowPrevNext=block |PrevPage=Documentation/DevGuide/JavaBean/The Internal Office Bean API |NextPage=Documentation/DevGuide…'

{{Documentation/DevGuide/JavaBeanTOC
|JavaBean2b=block
|ShowPrevNext=block
|PrevPage=Documentation/DevGuide/JavaBean/The Internal Office Bean API
|NextPage=Documentation/DevGuide/JavaBean/OfficeWindow Interface
}}
{{Documentation/DevGuideLanguages|Documentation/DevGuide/JavaBean/{{SUBPAGENAME}}}}
{{DISPLAYTITLE:OfficeConnection インターフェース}}
インターフェース <code>com.sun.star.comp.beans.OfficeConnection</code> には、{{PRODUCTNAME}}[ の接続を設定、開始、管理するメソッドが含まれます。メソッドには次のものがあります。
<source lang="java">
public void setUnoUrl(String URL) throws java.net.MalformedURLException
public com.sun.star.uno.XComponentContext getComponentContext()
public OfficeWindow createOfficeWindow(Container container)
public void setContainerFactory(ContainerFactory containerFactory)
</source>
クライアントは <code>setUnoUrl()</code> を使用し、OfficeBean がどのように {{PRODUCTNAME}} プロセスに接続するか指定します。URL のシンタックスに関する詳細については、[[Documentation/DevGuide/JavaBean/Configuring the Office Bean|OfficeBean の設定]]の節を参照してください。クライアントが不正に形成された URL を引数として渡した場合は、具体的な実装によって <code>java.net.MalformedURLException</code> がスローされます。

メソッド <code>getComponentContext()</code> は、OfficeBean からインターフェース <idl>com.sun.star.uno.XComponentContext</idl> を実装するオブジェクトを取得します。このオブジェクトは、バックエンドの {{PRODUCTNAME}} プロセスから {{PRODUCTNAME}} の完全な API を実装するオブジェクトを取得します。

<code>createOfficeWindow()</code> への呼び出しは、 <code>OfficeConnection</code> から新規 <code>OfficeWindow</code> を要求します。クライアントは <code>OfficeWindow</code> から <code>java.awt.Component</code> を取得し、それを UI に埋め込みます。次のメソッド <code>getAWTComponent()</code> で、<code>OfficeWindow</code> から Component を取得する方法を確認します。クライアントは、作成すべき <code>OfficeWindow</code> を示す <code>java.awt.Container</code> を実装に提供します。

メソッド <code>setContainerFactory()</code> は、Java 環境でポップアップウィンドウを表示するための Java AWT ウィンドウを作成するファクトリーオブジェクトを OfficeBean に指定します。このファクトリーオブジェクトは、インターフェース <code>com.sun.star.comp.beans.ContainerFactory</code> を実装します。インターフェース <code>ContainerFactory</code> の定義については、以下を参照してください。

クライアントが自分独自のインターフェース <code>ContainerFactory</code> を実装しない場合、OfficeBean はデフォルトの <code>ContainerFactory</code> を使用して、のインスタンスを作成します。<code>java.awt.Canvas</code>

{{PDL1}}

[[Category:Documentation/Developer's Guide/JavaBean for Office Components]]

[[Category:G11n Wiki Translation]]

Template:G11NWIKITEST/Documentation/BASICGuideTOC/v2

2009-09-17T15:15:14Z

G11nAutomation:

{{Documentation/MasterTOC
|ShowPrevPage={{{ShowPrevPage}}}
|PrevPage={{{PrevPage}}}
|ShowNextPage={{{ShowNextPage}}}
|NextPage={{{NextPage}}}
|bookid=BASICGuide
|ShowParttitle=none
|ShowPrevPart=none
|ShowNextPart=none
|booktitle=[[G11NWIKITEST/Documentation/BASIC Guide|BASIC Guide]]
|toccontent=<section begin=toccontent />
* [[G11NWIKITEST/Documentation/BASIC Guide/Language|The Language of {{OOo}} Basic]]
<div id="lang" style="display:{{{lang|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Program Overview|Overview of a Basic Program]]
* [[Documentation/BASIC Guide/Working With Variables|Working With Variables]]
* [[G11NWIKITEST/Documentation/BASIC Guide/Strings|Strings]]
* [[Documentation/BASIC Guide/Numbers|Numbers]]
* [[Documentation/BASIC Guide/Boolean|Boolean Values]]
* [[Documentation/BASIC Guide/Date|Date and Time]]
* [[Documentation/BASIC Guide/Arrays|Arrays]]
* [[Documentation/BASIC Guide/Scope of Variables|Scope and Life Span of Variables]]
* [[Documentation/BASIC Guide/Constants|Constants]]
* [[Documentation/BASIC Guide/Operators|Operators]]
* [[Documentation/BASIC Guide/Branching|Branching]]
* [[Documentation/BASIC Guide/Loops|Loops]]
* [[Documentation/BASIC Guide/Procedures and Functions|Procedures and Functions]]
* [[Documentation/BASIC Guide/Error Handling|Error Handling]]
* [[Documentation/BASIC Guide/Other Instructions|Other Instructions]]
</div>
* [[Documentation/BASIC Guide/Runtime Library|Runtime Library]]
<div id="runtime" style="display:{{{runtime|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Conversion Functions (Runtime Library)|Conversion Functions]]
* [[Documentation/BASIC Guide/Strings (Runtime Library)|Strings]]
* [[Documentation/BASIC Guide/Date and Time (Runtime Library)|Date and Time]]
* [[Documentation/BASIC Guide/Files and Directories (Runtime Library)|Files and Directories]]
* [[Documentation/BASIC Guide/Message and Input Boxes (Runtime Library)|Message and Input Boxes]]
* [[Documentation/BASIC Guide/Other Functions (Runtime Library)|Other Functions]]
</div>
* [[Documentation/BASIC Guide/API Intro|Introduction to the API]]
<div id="api" style="display:{{{api|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/UNO|Universal Network Objects (UNO)]]
* [[Documentation/BASIC Guide/Properties and Methods (API)|Properties and Methods]]
* [[Documentation/BASIC Guide/Modules, Services and Interfaces|Modules, Services and Interfaces]]
* [[Documentation/BASIC Guide/UNO Tools|Tools for Working with UNO]]
* [[Documentation/BASIC Guide/Interface Overview|Overview of Central Interfaces]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Documents|Working with Documents]]
<div id="docs" style="display:{{{docs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/StarDesktop|The StarDesktop]]
* [[Documentation/BASIC Guide/Templates|Templates]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Text Documents|Text Documents]]
<div id="textdocs" style="display:{{{textdocs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Text Documents|The Structure of Text Documents]]
* [[Documentation/BASIC Guide/Editing Text Documents|Editing Text Documents]]
* [[Documentation/BASIC Guide/More Than Text|More than Just Text]]
</div>
* [[Documentation/BASIC Guide/Spreadsheets|Spreadsheet Documents]]
<div id="spread" style="display:{{{spread|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Spreadsheets|The Structure of Spreadsheets]]
** [[Documentation/BASIC Guide/Rows and Columns|Rows and Columns]]
** [[Documentation/BASIC Guide/Cells and Ranges|Cells and Ranges]]
** [[Documentation/BASIC Guide/Formatting Spreadsheet Documents|Formatting Spreadsheet Documents]]
* [[Documentation/BASIC Guide/Editing Spreadsheet Documents|Editing Spreadsheet Documents]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Drawings Presentations|绘图和演示]]
<div id="draw" style="display:{{{draw|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Drawings|The Structure of Drawings]]
* [[Documentation/BASIC Guide/Editing Drawing Objects|Editing Drawing Objects]]
* [[Documentation/BASIC Guide/Presentations|Presentations]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Charts|Charts (Diagrams)]]
<div id="chart" style="display:{{{chart|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Charts in Spreadsheets|Using Charts in Spreadsheets]]
* [[Documentation/BASIC Guide/Structure of Charts|The Structure of Charts]]
* [[Documentation/BASIC Guide/Chart Types|Chart Types]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Database|Databases]]
<div id="base" style="display:{{{base|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/SQL|SQL: a Query Language]]
* [[Documentation/BASIC Guide/Database Access Types|Types of Database Access]]
* [[Documentation/BASIC Guide/Data Sources|Data Sources]]
* [[Documentation/BASIC Guide/Database Access|Database Access]]
</div>
* [[Documentation/BASIC Guide/Dialogs|Dialogs]]
<div id="dial" style="display:{{{dial|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Dialogs|Working With Dialogs]]
* [[Documentation/BASIC Guide/Properties|Properties]]
* [[Documentation/BASIC Guide/Events|Events]]
* [[Documentation/BASIC Guide/Control Elements|Dialog Control Elements]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Forms|Forms]]
<div id="form" style="display:{{{form|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Forms|Working With Forms]]
* [[Documentation/BASIC Guide/Control Element Forms|Control Element Forms]]
* [[Documentation/BASIC Guide/Database Forms|Database Forms]]
</div>
<section end=toccontent />}}

[[Category:Documentation/BASIC Guide]]

<noinclude>
[[Category:Exclude in print|{{PAGENAME}}]]

</noinclude>
[[Category:G11n Wiki Translation]]

G11NWIKITEST/Documentation/BASIC Guide/Strings (Runtime Library)

2009-09-17T15:13:32Z

G11nAutomation:

{{G11NWIKITEST/Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Conversion Functions (Runtime Library)
|NextPage=Documentation/BASIC Guide/Date and Time (Runtime Library)
|runtime=block
}}
{{DISPLAYTITLE:字符串 ({{OOo}} BASIC 运行库)}}
__NOTOC__
== Working with Sets of Characters ==

When administering strings, {{OOo}} Basic uses the set of Unicode characters. The <tt>Asc</tt> and <tt>Chr</tt> functions allow the Unicode value belonging to a character to be established and/or the corresponding character to be found for a Unicode value. The following expressions assign the various Unicode values to the code variable:

<source lang="oobas">
Code = Asc("A") ' Latin letter A (Unicode-value 65)
Code = Asc("€") ' Euro character (Unicode-value 8364)
Code = Asc("Л") ' Cyrillic letter Л (Unicode-value 1083)
</source>

Conversely, the expression

<source lang="oobas">
MyString = Chr(13)
</source>

ensures that the <tt>MyString</tt> string is initialized with the value of the number <tt>13</tt>, which stands for a hard line break.

The <tt>Chr</tt> command is often used in Basic languages to insert control characters in a string. The assignment

<source lang="oobas">
MyString = Chr(9) + "This is a test" + Chr(13)
</source>

therefore ensures that the text is preceded by a tab character (Unicode-value 9) and that a hard line break (Unicode-value 13) is added after the text.

== Accessing Parts of a String ==

{{OOo}} Basic provides three functions that return partial strings, plus a length function:

;<tt>Left(MyString, Length)</tt>:returns the first <tt>Length</tt> characters of <tt>MyString</tt>.
;<tt>Right(MyString, Length)</tt>:returns the last <tt>Length</tt> characters of <tt>MyString</tt>.
;<tt>Mid(MyString, Start, Length)</tt>:returns first <tt>Length</tt> characters of <tt>MyString</tt> as of the <tt>Start</tt> position.
;<tt>Len(MyString)</tt>:returns the number of characters in <tt>MyString</tt>.

Here are a few example calls for the named functions:

<source lang="oobas">
Dim MyString As String
Dim MyResult As String
Dim MyLen As Integer

MyString = "This is a small test"
MyResult = Left(MyString,5) ' Provides the string "This "
MyResult = Right(MyString, 5) ' Provides the string " test"
MyResult = Mid(MyString, 8, 5) ' Provides the string " a sm"
MyLen = Len(MyString) ' Provides the value 20
</source>

== Search and Replace ==

{{OOo}} Basic provides the <tt>InStr</tt> function for searching for a partial string within another string:

<source lang="oobas">
ResultString = InStr (MyString, SearchString)
</source>

The <tt>SearchString</tt> parameter specifies the string to be searched for within <tt>MyString</tt>. The function returns a number that contains the position at which the <tt>SearchString</tt> first appears within <tt>MyString</tt>; a return value of zero indicates no match. If you want to find other matches for the string, the function also provides the opportunity to specify an optional start position from which {{OOo}} Basic begins the search. In this case, the syntax of the function is:

<source lang="oobas">
ResultString = InStr(StartPosition, MyString, SearchString)
</source>

In the previous examples, <tt>InStr</tt> ignores uppercase and lowercase characters. To change the search so that <tt>InStr</tt> is case sensitive, add the parameter <tt>0</tt>, as shown in the following example:

<source lang="oobas">
ResultString = InStr(MyString, SearchString, 0)
</source>

Using the previous functions for editing strings, programmers can search for and replace one string in another string:

<source lang="oobas">
Function Replace(Source As String, Search As String, NewPart As String)
Dim Result As String
Dim StartPos As Long
Dim CurrentPos As Long

Result = ""
StartPos = 1
CurrentPos = 1

If Search = "" Then
Result = Source
Else
Do While CurrentPos <> 0
CurrentPos = InStr(StartPos, Source, Search)
If CurrentPos <> 0 Then
Result = Result + Mid(Source, StartPos, _
CurrentPos - StartPos)
Result = Result + NewPart
StartPos = CurrentPos + Len(Search)
Else
Result = Result + Mid(Source, StartPos, Len(Source))
End If ' Position <> 0
Loop
End If

Replace = Result
End Function
</source>

The function searches through the transferred <tt>Search</tt> string in a loop by means of <tt>InStr</tt> in the original term <tt>Source</tt>. If it finds the search term, it takes the part before the expression and writes it to the <tt>Result</tt> return buffer. It adds the <tt>NewPart</tt> section at the point of the search term <tt>Search</tt>. If no more matches are found for the search term, the function establishes the part of the string still remaining and adds this to the return buffer. It returns the string produced in this way as the result of the replacement process.

Since replacing parts of character sequences is one of the most frequently used functions, the <tt>Mid</tt> function in {{OOo}} Basic has been extended so that this task is performed automatically. The following example replaces three characters with the string <tt>is</tt> from the sixth position of the <tt>MyString</tt> string.

<source lang="oobas">
Dim MyString As String

MyString = "This was my text"
Mid(MyString, 6, 3, "is")
</source>

== Formatting Strings ==

The <tt>Format</tt> function formats numbers as a string. To do this, the function expects a <tt>Format</tt> expression to be specified, which is then used as the template for formatting the numbers. Each place holder within the template ensures that this item is formatted correspondingly in the output value. The five most important place holders within a template are the zero (<tt>0</tt>), pound sign (<tt>#</tt>), period (<tt>.</tt>), comma (<tt>,</tt>) and dollar sign (<tt>$</tt>) characters.

The <tt>0</tt> character within the template ensures that a number is always placed at the corresponding point. If a number is not provided, 0 is displayed in its place.

A <tt>.</tt> stands for the decimal point symbol defined by the operating system in the country-specific settings.

The example below shows how the <tt>0</tt> and <tt>.</tt> characters can define the digits after the decimal point in an expression:

<source lang="oobas">
MyFormat = "0.00"
MyString = Format(-1579.8, MyFormat) ' Provides "-1579,80"
MyString = Format(1579.8, MyFormat) ' Provides "1579,80"
MyString = Format(0.4, MyFormat) ' Provides "0,40"
MyString = Format(0.434, MyFormat) ' Provides "0,43"
</source>

In the same way, zeros can be added in front of a number to achieve the desired length:

<source lang="oobas">
MyFormat = "0000.00"
MyString = Format(-1579.8, MyFormat) ' Provides "-1579,80"
MyString = Format(1579.8, MyFormat) ' Provides "1579,80"
MyString = Format(0.4, MyFormat) ' Provides "0000,40"
MyString = Format(0.434, MyFormat) ' Provides "0000,43"
</source>

A <tt>,</tt> represents the character that the operating system uses for a thousands separator, and the <tt>#</tt> stands for a digit or place that is only displayed if it is required by the input string.

<source lang="oobas">
MyFormat = "#,##0.00"
MyString = Format(-1579.8, MyFormat) ' Provides "-1.579,80"
MyString = Format(1579.8, MyFormat) ' Provides "1.579,80"
MyString = Format(0.4, MyFormat) ' Provides "0,40"
MyString = Format(0.434, MyFormat) ' Provides "0,43"
</source>

In place of the <tt>$</tt> place holder, the <tt>Format</tt> function displays the relevant currency symbol defined by the system (this example assumes a European locale has been defined):

<source lang="oobas">
MyFormat = "#,##0.00 $"
MyString = Format(-1579.8, MyFormat) ' Provides "-1.579,80 €"
MyString = Format(1579.8, MyFormat) ' Provides "1.579,80 €"
MyString = Format(0.4, MyFormat) ' Provides "0,40 €"
MyString = Format(0.434, MyFormat) ' Provides "0,43 €"
</source>

The format instructions used in VBA for formatting date and time details can also be used:

<source lang="oobas">
sub main
dim myDate as date
myDate = "01/06/98"
TestStr = Format(myDate, "mm-dd-yyyy") ' 01-06-1998
MsgBox TestStr
end sub
</source>

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide/Strings (Runtime Library)}}
{{PDL1}}

[[Category:G11n Wiki Translation]]

G11NWIKITEST/Documentation/BASIC Guide/Strings

2009-09-17T15:13:24Z

G11nAutomation:

{{DISPLAYTITLE: 字符串变量}}
{{G11NWIKITEST/Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Working With Variables
|NextPage=Documentation/BASIC Guide/Numbers
|lang=block
}}
__NOTOC__
Strings, together with numbers, form the most important basic types of {{OOo}} Basic. A string consists of a sequence of consecutive individual characters. The computer saves the strings internally as a sequence of numbers where each number represents one specific character.

==From a Set of ASCII Characters to Unicode==

Character sets match characters in a string with a corresponding code (numbers and characters) in a table that describes how the computer is to display the string.

===The ASCII Character Set===

The ASCII character set is a set of codes that represent numbers, characters, and special symbols by one byte. The 0 to 127 ASCII codes correspond to the alphabet and to common symbols (such as periods, parentheses, and commas), as well as some special screen and printer control codes. The ASCII character set is commonly used as a standard format for transferring text data between computers.

However, this character set does not include a range of special characters used in Europe, such as â, ä, and î, as well as other character formats, such as the Cyrillic alphabet.

===The ANSI Character Set===

Microsoft based its Windows product on the American National Standards Institute (ANSI) character set, which was gradually extended to include characters that are missing from the ASCII character set.

===Code Pages===

The ISO 8859 character sets provide an international standard. The first 128 characters of the ISO character set correspond to the ASCII character set. The ISO standard introduces new character sets ('''code pages''') so that more languages can be correctly displayed. However, as a result, the same character value can represent different characters in different languages.

===Unicode===

Unicode increases the length of a character to four bytes and combines different character sets to create a standard to depict as many of the world's languages as possible. Version 2.0 of Unicode is now supported by many programs — including {{OOo}} and {{OOo}} Basic.

==String Variables==

{{OOo}} Basic saves strings as string variables in Unicode. A string variable can store up to 65535 characters. Internally, {{OOo}} Basic saves the associated Unicode value for every character. The working memory needed for a string variable depends on the length of the string.

Example declaration of a string variable:

<source lang="oobas">
Dim Variable As String
</source>

You can also write this declaration as:

<source lang="oobas">
Dim Variable$
</source>

{{Documentation/Note|When porting VBA applications, ensure that the maximum allowed string length in {{OOo}} Basic is observed (65535 characters).}}

==Specification of Explicit Strings==

To assign an explicit string to a string variable, enclose the string in quotation marks (").

<source lang="oobas">
Dim MyString As String
MyString = " This is a test"
</source>

To split a string across two lines of code, add an ampersand sign (the concatenation operator) and the underscore continuation character at the end of the first line:

<source lang="oobas">
Dim MyString As String
MyString = "This string is so long that it " & _
"has been split over two lines."
</source>

To include a quotation mark (") in a string, enter it twice at the relevant point:

<source lang="oobas">
Dim MyString As String
MyString = "a ""-quotation mark." ' produces a "-quotation mark
</source>

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide/Strings}}
{{PDL1}}

[[Category:G11n Wiki Translation]]

G11NWIKITEST/Documentation/BASIC Guide/Strings (Runtime Library)

2009-09-17T15:12:05Z

G11nAutomation:

{{Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Conversion Functions (Runtime Library)
|NextPage=Documentation/BASIC Guide/Date and Time (Runtime Library)
|runtime=block
}}
{{DISPLAYTITLE:字符串 ({{OOo}} BASIC 运行库)}}
__NOTOC__
== Working with Sets of Characters ==

When administering strings, {{OOo}} Basic uses the set of Unicode characters. The <tt>Asc</tt> and <tt>Chr</tt> functions allow the Unicode value belonging to a character to be established and/or the corresponding character to be found for a Unicode value. The following expressions assign the various Unicode values to the code variable:

<source lang="oobas">
Code = Asc("A") ' Latin letter A (Unicode-value 65)
Code = Asc("€") ' Euro character (Unicode-value 8364)
Code = Asc("Л") ' Cyrillic letter Л (Unicode-value 1083)
</source>

Conversely, the expression

<source lang="oobas">
MyString = Chr(13)
</source>

ensures that the <tt>MyString</tt> string is initialized with the value of the number <tt>13</tt>, which stands for a hard line break.

The <tt>Chr</tt> command is often used in Basic languages to insert control characters in a string. The assignment

<source lang="oobas">
MyString = Chr(9) + "This is a test" + Chr(13)
</source>

therefore ensures that the text is preceded by a tab character (Unicode-value 9) and that a hard line break (Unicode-value 13) is added after the text.

== Accessing Parts of a String ==

{{OOo}} Basic provides three functions that return partial strings, plus a length function:

;<tt>Left(MyString, Length)</tt>:returns the first <tt>Length</tt> characters of <tt>MyString</tt>.
;<tt>Right(MyString, Length)</tt>:returns the last <tt>Length</tt> characters of <tt>MyString</tt>.
;<tt>Mid(MyString, Start, Length)</tt>:returns first <tt>Length</tt> characters of <tt>MyString</tt> as of the <tt>Start</tt> position.
;<tt>Len(MyString)</tt>:returns the number of characters in <tt>MyString</tt>.

Here are a few example calls for the named functions:

<source lang="oobas">
Dim MyString As String
Dim MyResult As String
Dim MyLen As Integer

MyString = "This is a small test"
MyResult = Left(MyString,5) ' Provides the string "This "
MyResult = Right(MyString, 5) ' Provides the string " test"
MyResult = Mid(MyString, 8, 5) ' Provides the string " a sm"
MyLen = Len(MyString) ' Provides the value 20
</source>

== Search and Replace ==

{{OOo}} Basic provides the <tt>InStr</tt> function for searching for a partial string within another string:

<source lang="oobas">
ResultString = InStr (MyString, SearchString)
</source>

The <tt>SearchString</tt> parameter specifies the string to be searched for within <tt>MyString</tt>. The function returns a number that contains the position at which the <tt>SearchString</tt> first appears within <tt>MyString</tt>; a return value of zero indicates no match. If you want to find other matches for the string, the function also provides the opportunity to specify an optional start position from which {{OOo}} Basic begins the search. In this case, the syntax of the function is:

<source lang="oobas">
ResultString = InStr(StartPosition, MyString, SearchString)
</source>

In the previous examples, <tt>InStr</tt> ignores uppercase and lowercase characters. To change the search so that <tt>InStr</tt> is case sensitive, add the parameter <tt>0</tt>, as shown in the following example:

<source lang="oobas">
ResultString = InStr(MyString, SearchString, 0)
</source>

Using the previous functions for editing strings, programmers can search for and replace one string in another string:

<source lang="oobas">
Function Replace(Source As String, Search As String, NewPart As String)
Dim Result As String
Dim StartPos As Long
Dim CurrentPos As Long

Result = ""
StartPos = 1
CurrentPos = 1

If Search = "" Then
Result = Source
Else
Do While CurrentPos <> 0
CurrentPos = InStr(StartPos, Source, Search)
If CurrentPos <> 0 Then
Result = Result + Mid(Source, StartPos, _
CurrentPos - StartPos)
Result = Result + NewPart
StartPos = CurrentPos + Len(Search)
Else
Result = Result + Mid(Source, StartPos, Len(Source))
End If ' Position <> 0
Loop
End If

Replace = Result
End Function
</source>

The function searches through the transferred <tt>Search</tt> string in a loop by means of <tt>InStr</tt> in the original term <tt>Source</tt>. If it finds the search term, it takes the part before the expression and writes it to the <tt>Result</tt> return buffer. It adds the <tt>NewPart</tt> section at the point of the search term <tt>Search</tt>. If no more matches are found for the search term, the function establishes the part of the string still remaining and adds this to the return buffer. It returns the string produced in this way as the result of the replacement process.

Since replacing parts of character sequences is one of the most frequently used functions, the <tt>Mid</tt> function in {{OOo}} Basic has been extended so that this task is performed automatically. The following example replaces three characters with the string <tt>is</tt> from the sixth position of the <tt>MyString</tt> string.

<source lang="oobas">
Dim MyString As String

MyString = "This was my text"
Mid(MyString, 6, 3, "is")
</source>

== Formatting Strings ==

The <tt>Format</tt> function formats numbers as a string. To do this, the function expects a <tt>Format</tt> expression to be specified, which is then used as the template for formatting the numbers. Each place holder within the template ensures that this item is formatted correspondingly in the output value. The five most important place holders within a template are the zero (<tt>0</tt>), pound sign (<tt>#</tt>), period (<tt>.</tt>), comma (<tt>,</tt>) and dollar sign (<tt>$</tt>) characters.

The <tt>0</tt> character within the template ensures that a number is always placed at the corresponding point. If a number is not provided, 0 is displayed in its place.

A <tt>.</tt> stands for the decimal point symbol defined by the operating system in the country-specific settings.

The example below shows how the <tt>0</tt> and <tt>.</tt> characters can define the digits after the decimal point in an expression:

<source lang="oobas">
MyFormat = "0.00"
MyString = Format(-1579.8, MyFormat) ' Provides "-1579,80"
MyString = Format(1579.8, MyFormat) ' Provides "1579,80"
MyString = Format(0.4, MyFormat) ' Provides "0,40"
MyString = Format(0.434, MyFormat) ' Provides "0,43"
</source>

In the same way, zeros can be added in front of a number to achieve the desired length:

<source lang="oobas">
MyFormat = "0000.00"
MyString = Format(-1579.8, MyFormat) ' Provides "-1579,80"
MyString = Format(1579.8, MyFormat) ' Provides "1579,80"
MyString = Format(0.4, MyFormat) ' Provides "0000,40"
MyString = Format(0.434, MyFormat) ' Provides "0000,43"
</source>

A <tt>,</tt> represents the character that the operating system uses for a thousands separator, and the <tt>#</tt> stands for a digit or place that is only displayed if it is required by the input string.

<source lang="oobas">
MyFormat = "#,##0.00"
MyString = Format(-1579.8, MyFormat) ' Provides "-1.579,80"
MyString = Format(1579.8, MyFormat) ' Provides "1.579,80"
MyString = Format(0.4, MyFormat) ' Provides "0,40"
MyString = Format(0.434, MyFormat) ' Provides "0,43"
</source>

In place of the <tt>$</tt> place holder, the <tt>Format</tt> function displays the relevant currency symbol defined by the system (this example assumes a European locale has been defined):

<source lang="oobas">
MyFormat = "#,##0.00 $"
MyString = Format(-1579.8, MyFormat) ' Provides "-1.579,80 €"
MyString = Format(1579.8, MyFormat) ' Provides "1.579,80 €"
MyString = Format(0.4, MyFormat) ' Provides "0,40 €"
MyString = Format(0.434, MyFormat) ' Provides "0,43 €"
</source>

The format instructions used in VBA for formatting date and time details can also be used:

<source lang="oobas">
sub main
dim myDate as date
myDate = "01/06/98"
TestStr = Format(myDate, "mm-dd-yyyy") ' 01-06-1998
MsgBox TestStr
end sub
</source>

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide/Strings (Runtime Library)}}
{{PDL1}}

[[Category:G11n Wiki Translation]]

Template:G11NWIKITEST/Documentation/BASICGuideTOC/v2

2009-09-17T15:12:01Z

G11nAutomation:

{{Documentation/MasterTOC
|ShowPrevPage={{{ShowPrevPage}}}
|PrevPage={{{PrevPage}}}
|ShowNextPage={{{ShowNextPage}}}
|NextPage={{{NextPage}}}
|bookid=BASICGuide
|ShowParttitle=none
|ShowPrevPart=none
|ShowNextPart=none
|booktitle=[[Documentation/BASIC Guide|BASIC Guide]]
|toccontent=<section begin=toccontent />
* [[Documentation/BASIC Guide/Language|The Language of {{OOo}} Basic]]
<div id="lang" style="display:{{{lang|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Program Overview|Overview of a Basic Program]]
* [[Documentation/BASIC Guide/Working With Variables|Working With Variables]]
* [[Documentation/BASIC Guide/Strings|Strings]]
* [[Documentation/BASIC Guide/Numbers|Numbers]]
* [[Documentation/BASIC Guide/Boolean|Boolean Values]]
* [[Documentation/BASIC Guide/Date|Date and Time]]
* [[Documentation/BASIC Guide/Arrays|Arrays]]
* [[Documentation/BASIC Guide/Scope of Variables|Scope and Life Span of Variables]]
* [[Documentation/BASIC Guide/Constants|Constants]]
* [[Documentation/BASIC Guide/Operators|Operators]]
* [[Documentation/BASIC Guide/Branching|Branching]]
* [[Documentation/BASIC Guide/Loops|Loops]]
* [[Documentation/BASIC Guide/Procedures and Functions|Procedures and Functions]]
* [[Documentation/BASIC Guide/Error Handling|Error Handling]]
* [[Documentation/BASIC Guide/Other Instructions|Other Instructions]]
</div>
* [[Documentation/BASIC Guide/Runtime Library|Runtime Library]]
<div id="runtime" style="display:{{{runtime|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Conversion Functions (Runtime Library)|Conversion Functions]]
* [[Documentation/BASIC Guide/Strings (Runtime Library)|Strings]]
* [[Documentation/BASIC Guide/Date and Time (Runtime Library)|Date and Time]]
* [[Documentation/BASIC Guide/Files and Directories (Runtime Library)|Files and Directories]]
* [[Documentation/BASIC Guide/Message and Input Boxes (Runtime Library)|Message and Input Boxes]]
* [[Documentation/BASIC Guide/Other Functions (Runtime Library)|Other Functions]]
</div>
* [[Documentation/BASIC Guide/API Intro|Introduction to the API]]
<div id="api" style="display:{{{api|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/UNO|Universal Network Objects (UNO)]]
* [[Documentation/BASIC Guide/Properties and Methods (API)|Properties and Methods]]
* [[Documentation/BASIC Guide/Modules, Services and Interfaces|Modules, Services and Interfaces]]
* [[Documentation/BASIC Guide/UNO Tools|Tools for Working with UNO]]
* [[Documentation/BASIC Guide/Interface Overview|Overview of Central Interfaces]]
</div>
* [[Documentation/BASIC Guide/Documents|Working with Documents]]
<div id="docs" style="display:{{{docs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/StarDesktop|The StarDesktop]]
* [[Documentation/BASIC Guide/Templates|Templates]]
</div>
* [[Documentation/BASIC Guide/Text Documents|Text Documents]]
<div id="textdocs" style="display:{{{textdocs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Text Documents|The Structure of Text Documents]]
* [[Documentation/BASIC Guide/Editing Text Documents|Editing Text Documents]]
* [[Documentation/BASIC Guide/More Than Text|More than Just Text]]
</div>
* [[Documentation/BASIC Guide/Spreadsheets|Spreadsheet Documents]]
<div id="spread" style="display:{{{spread|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Spreadsheets|The Structure of Spreadsheets]]
** [[Documentation/BASIC Guide/Rows and Columns|Rows and Columns]]
** [[Documentation/BASIC Guide/Cells and Ranges|Cells and Ranges]]
** [[Documentation/BASIC Guide/Formatting Spreadsheet Documents|Formatting Spreadsheet Documents]]
* [[Documentation/BASIC Guide/Editing Spreadsheet Documents|Editing Spreadsheet Documents]]
</div>
* [[Documentation/BASIC Guide/Drawings Presentations|绘图和演示]]
<div id="draw" style="display:{{{draw|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Drawings|The Structure of Drawings]]
* [[Documentation/BASIC Guide/Editing Drawing Objects|Editing Drawing Objects]]
* [[Documentation/BASIC Guide/Presentations|Presentations]]
</div>
* [[Documentation/BASIC Guide/Charts|Charts (Diagrams)]]
<div id="chart" style="display:{{{chart|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Charts in Spreadsheets|Using Charts in Spreadsheets]]
* [[Documentation/BASIC Guide/Structure of Charts|The Structure of Charts]]
* [[Documentation/BASIC Guide/Chart Types|Chart Types]]
</div>
* [[Documentation/BASIC Guide/Database|Databases]]
<div id="base" style="display:{{{base|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/SQL|SQL: a Query Language]]
* [[Documentation/BASIC Guide/Database Access Types|Types of Database Access]]
* [[Documentation/BASIC Guide/Data Sources|Data Sources]]
* [[Documentation/BASIC Guide/Database Access|Database Access]]
</div>
* [[Documentation/BASIC Guide/Dialogs|Dialogs]]
<div id="dial" style="display:{{{dial|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Dialogs|Working With Dialogs]]
* [[Documentation/BASIC Guide/Properties|Properties]]
* [[Documentation/BASIC Guide/Events|Events]]
* [[Documentation/BASIC Guide/Control Elements|Dialog Control Elements]]
</div>
* [[Documentation/BASIC Guide/Forms|Forms]]
<div id="form" style="display:{{{form|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Forms|Working With Forms]]
* [[Documentation/BASIC Guide/Control Element Forms|Control Element Forms]]
* [[Documentation/BASIC Guide/Database Forms|Database Forms]]
</div>
<section end=toccontent />}}

[[Category:Documentation/BASIC Guide]]

<noinclude>
[[Category:Exclude in print|{{PAGENAME}}]]

</noinclude>
[[Category:G11n Wiki Translation]]

G11NWIKITEST/Documentation/BASIC Guide/Strings

2009-09-17T15:11:58Z

G11nAutomation:

{{DISPLAYTITLE: 字符串变量}}
{{Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Working With Variables
|NextPage=Documentation/BASIC Guide/Numbers
|lang=block
}}
__NOTOC__
Strings, together with numbers, form the most important basic types of {{OOo}} Basic. A string consists of a sequence of consecutive individual characters. The computer saves the strings internally as a sequence of numbers where each number represents one specific character.

==From a Set of ASCII Characters to Unicode==

Character sets match characters in a string with a corresponding code (numbers and characters) in a table that describes how the computer is to display the string.

===The ASCII Character Set===

The ASCII character set is a set of codes that represent numbers, characters, and special symbols by one byte. The 0 to 127 ASCII codes correspond to the alphabet and to common symbols (such as periods, parentheses, and commas), as well as some special screen and printer control codes. The ASCII character set is commonly used as a standard format for transferring text data between computers.

However, this character set does not include a range of special characters used in Europe, such as â, ä, and î, as well as other character formats, such as the Cyrillic alphabet.

===The ANSI Character Set===

Microsoft based its Windows product on the American National Standards Institute (ANSI) character set, which was gradually extended to include characters that are missing from the ASCII character set.

===Code Pages===

The ISO 8859 character sets provide an international standard. The first 128 characters of the ISO character set correspond to the ASCII character set. The ISO standard introduces new character sets ('''code pages''') so that more languages can be correctly displayed. However, as a result, the same character value can represent different characters in different languages.

===Unicode===

Unicode increases the length of a character to four bytes and combines different character sets to create a standard to depict as many of the world's languages as possible. Version 2.0 of Unicode is now supported by many programs — including {{OOo}} and {{OOo}} Basic.

==String Variables==

{{OOo}} Basic saves strings as string variables in Unicode. A string variable can store up to 65535 characters. Internally, {{OOo}} Basic saves the associated Unicode value for every character. The working memory needed for a string variable depends on the length of the string.

Example declaration of a string variable:

<source lang="oobas">
Dim Variable As String
</source>

You can also write this declaration as:

<source lang="oobas">
Dim Variable$
</source>

{{Documentation/Note|When porting VBA applications, ensure that the maximum allowed string length in {{OOo}} Basic is observed (65535 characters).}}

==Specification of Explicit Strings==

To assign an explicit string to a string variable, enclose the string in quotation marks (").

<source lang="oobas">
Dim MyString As String
MyString = " This is a test"
</source>

To split a string across two lines of code, add an ampersand sign (the concatenation operator) and the underscore continuation character at the end of the first line:

<source lang="oobas">
Dim MyString As String
MyString = "This string is so long that it " & _
"has been split over two lines."
</source>

To include a quotation mark (") in a string, enter it twice at the relevant point:

<source lang="oobas">
Dim MyString As String
MyString = "a ""-quotation mark." ' produces a "-quotation mark
</source>

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide/Strings}}
{{PDL1}}

[[Category:G11n Wiki Translation]]

Template:G11NWIKITEST/Documentation/BASICGuideTOC/v2

2009-09-17T14:54:40Z

G11nAutomation:

{{Documentation/MasterTOC
|ShowPrevPage={{{ShowPrevPage}}}
|PrevPage={{{PrevPage}}}
|ShowNextPage={{{ShowNextPage}}}
|NextPage={{{NextPage}}}
|bookid=BASICGuide
|ShowParttitle=none
|ShowPrevPart=none
|ShowNextPart=none
|booktitle=[[G11NWIKITEST/Documentation/BASIC Guide|BASIC Guide]]
|toccontent=<section begin=toccontent />
* [[Documentation/BASIC Guide/Language|The Language of {{OOo}} Basic]]
<div id="lang" style="display:{{{lang|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Program Overview|Overview of a Basic Program]]
* [[Documentation/BASIC Guide/Working With Variables|Working With Variables]]
* [[Documentation/BASIC Guide/Strings|Strings]]
* [[Documentation/BASIC Guide/Numbers|Numbers]]
* [[Documentation/BASIC Guide/Boolean|Boolean Values]]
* [[Documentation/BASIC Guide/Date|Date and Time]]
* [[Documentation/BASIC Guide/Arrays|Arrays]]
* [[Documentation/BASIC Guide/Scope of Variables|Scope and Life Span of Variables]]
* [[Documentation/BASIC Guide/Constants|Constants]]
* [[Documentation/BASIC Guide/Operators|Operators]]
* [[Documentation/BASIC Guide/Branching|Branching]]
* [[Documentation/BASIC Guide/Loops|Loops]]
* [[Documentation/BASIC Guide/Procedures and Functions|Procedures and Functions]]
* [[Documentation/BASIC Guide/Error Handling|Error Handling]]
* [[Documentation/BASIC Guide/Other Instructions|Other Instructions]]
</div>
* [[Documentation/BASIC Guide/Runtime Library|Runtime Library]]
<div id="runtime" style="display:{{{runtime|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Conversion Functions (Runtime Library)|Conversion Functions]]
* [[Documentation/BASIC Guide/Strings (Runtime Library)|Strings]]
* [[Documentation/BASIC Guide/Date and Time (Runtime Library)|Date and Time]]
* [[Documentation/BASIC Guide/Files and Directories (Runtime Library)|Files and Directories]]
* [[Documentation/BASIC Guide/Message and Input Boxes (Runtime Library)|Message and Input Boxes]]
* [[Documentation/BASIC Guide/Other Functions (Runtime Library)|Other Functions]]
</div>
* [[Documentation/BASIC Guide/API Intro|Introduction to the API]]
<div id="api" style="display:{{{api|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/UNO|Universal Network Objects (UNO)]]
* [[Documentation/BASIC Guide/Properties and Methods (API)|Properties and Methods]]
* [[Documentation/BASIC Guide/Modules, Services and Interfaces|Modules, Services and Interfaces]]
* [[Documentation/BASIC Guide/UNO Tools|Tools for Working with UNO]]
* [[Documentation/BASIC Guide/Interface Overview|Overview of Central Interfaces]]
</div>
* [[Documentation/BASIC Guide/Documents|Working with Documents]]
<div id="docs" style="display:{{{docs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/StarDesktop|The StarDesktop]]
* [[Documentation/BASIC Guide/Templates|Templates]]
</div>
* [[Documentation/BASIC Guide/Text Documents|Text Documents]]
<div id="textdocs" style="display:{{{textdocs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Text Documents|The Structure of Text Documents]]
* [[Documentation/BASIC Guide/Editing Text Documents|Editing Text Documents]]
* [[Documentation/BASIC Guide/More Than Text|More than Just Text]]
</div>
* [[Documentation/BASIC Guide/Spreadsheets|Spreadsheet Documents]]
<div id="spread" style="display:{{{spread|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Spreadsheets|The Structure of Spreadsheets]]
** [[Documentation/BASIC Guide/Rows and Columns|Rows and Columns]]
** [[Documentation/BASIC Guide/Cells and Ranges|Cells and Ranges]]
** [[Documentation/BASIC Guide/Formatting Spreadsheet Documents|Formatting Spreadsheet Documents]]
* [[Documentation/BASIC Guide/Editing Spreadsheet Documents|Editing Spreadsheet Documents]]
</div>
* [[Documentation/BASIC Guide/Drawings Presentations|绘图和演示]]
<div id="draw" style="display:{{{draw|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Drawings|The Structure of Drawings]]
* [[Documentation/BASIC Guide/Editing Drawing Objects|Editing Drawing Objects]]
* [[Documentation/BASIC Guide/Presentations|Presentations]]
</div>
* [[Documentation/BASIC Guide/Charts|Charts (Diagrams)]]
<div id="chart" style="display:{{{chart|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Charts in Spreadsheets|Using Charts in Spreadsheets]]
* [[Documentation/BASIC Guide/Structure of Charts|The Structure of Charts]]
* [[Documentation/BASIC Guide/Chart Types|Chart Types]]
</div>
* [[Documentation/BASIC Guide/Database|Databases]]
<div id="base" style="display:{{{base|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/SQL|SQL: a Query Language]]
* [[Documentation/BASIC Guide/Database Access Types|Types of Database Access]]
* [[Documentation/BASIC Guide/Data Sources|Data Sources]]
* [[Documentation/BASIC Guide/Database Access|Database Access]]
</div>
* [[Documentation/BASIC Guide/Dialogs|Dialogs]]
<div id="dial" style="display:{{{dial|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Dialogs|Working With Dialogs]]
* [[Documentation/BASIC Guide/Properties|Properties]]
* [[Documentation/BASIC Guide/Events|Events]]
* [[Documentation/BASIC Guide/Control Elements|Dialog Control Elements]]
</div>
* [[Documentation/BASIC Guide/Forms|Forms]]
<div id="form" style="display:{{{form|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Forms|Working With Forms]]
* [[Documentation/BASIC Guide/Control Element Forms|Control Element Forms]]
* [[Documentation/BASIC Guide/Database Forms|Database Forms]]
</div>
<section end=toccontent />}}

[[Category:Documentation/BASIC Guide]]

<noinclude>
[[Category:Exclude in print|{{PAGENAME}}]]

</noinclude>
[[Category:G11n Wiki Translation]]

Template:G11NWIKITEST/Documentation/BASICGuideTOC/v2

2009-09-17T07:39:58Z

G11nAutomation:

G11NWIKITEST/Documentation/BASIC Guide/Strings (Runtime Library)

2009-09-17T07:38:14Z

G11nAutomation:

G11NWIKITEST/Documentation/BASIC Guide/Strings

2009-09-17T07:38:05Z

G11nAutomation:

G11NWIKITEST/Documentation/BASIC Guide/Strings (Runtime Library)

2009-09-17T07:32:35Z

G11nAutomation: Created page with '{{Documentation/BASICGuideTOC/v2 |ShowPrevNext=block |ShowPrevPage=block |PrevPage=Documentation/BASIC Guide/Conversion Functions (Runtime Library) |NextPage=Documentation/BASIC …'

Template:G11NWIKITEST/Documentation/BASICGuideTOC/v2

2009-09-17T07:32:31Z

G11nAutomation:

{{Documentation/MasterTOC
|ShowPrevPage={{{ShowPrevPage}}}
|PrevPage={{{PrevPage}}}
|ShowNextPage={{{ShowNextPage}}}
|NextPage={{{NextPage}}}
|bookid=BASICGuide
|ShowParttitle=none
|ShowPrevPart=none
|ShowNextPart=none
|booktitle=[[Documentation/BASIC Guide|BASIC Guide]]
|toccontent=<section begin=toccontent />
* [[Documentation/BASIC Guide/Language|The Language of {{OOo}} Basic]]
<div id="lang" style="display:{{{lang|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Program Overview|Overview of a Basic Program]]
* [[Documentation/BASIC Guide/Working With Variables|Working With Variables]]
* [[Documentation/BASIC Guide/Strings|Strings]]
* [[Documentation/BASIC Guide/Numbers|Numbers]]
* [[Documentation/BASIC Guide/Boolean|Boolean Values]]
* [[Documentation/BASIC Guide/Date|Date and Time]]
* [[Documentation/BASIC Guide/Arrays|Arrays]]
* [[Documentation/BASIC Guide/Scope of Variables|Scope and Life Span of Variables]]
* [[Documentation/BASIC Guide/Constants|Constants]]
* [[Documentation/BASIC Guide/Operators|Operators]]
* [[Documentation/BASIC Guide/Branching|Branching]]
* [[Documentation/BASIC Guide/Loops|Loops]]
* [[Documentation/BASIC Guide/Procedures and Functions|Procedures and Functions]]
* [[Documentation/BASIC Guide/Error Handling|Error Handling]]
* [[Documentation/BASIC Guide/Other Instructions|Other Instructions]]
</div>
* [[Documentation/BASIC Guide/Runtime Library|Runtime Library]]
<div id="runtime" style="display:{{{runtime|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Conversion Functions (Runtime Library)|Conversion Functions]]
* [[Documentation/BASIC Guide/Strings (Runtime Library)|Strings]]
* [[Documentation/BASIC Guide/Date and Time (Runtime Library)|Date and Time]]
* [[Documentation/BASIC Guide/Files and Directories (Runtime Library)|Files and Directories]]
* [[Documentation/BASIC Guide/Message and Input Boxes (Runtime Library)|Message and Input Boxes]]
* [[Documentation/BASIC Guide/Other Functions (Runtime Library)|Other Functions]]
</div>
* [[Documentation/BASIC Guide/API Intro|Introduction to the API]]
<div id="api" style="display:{{{api|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/UNO|Universal Network Objects (UNO)]]
* [[Documentation/BASIC Guide/Properties and Methods (API)|Properties and Methods]]
* [[Documentation/BASIC Guide/Modules, Services and Interfaces|Modules, Services and Interfaces]]
* [[Documentation/BASIC Guide/UNO Tools|Tools for Working with UNO]]
* [[Documentation/BASIC Guide/Interface Overview|Overview of Central Interfaces]]
</div>
* [[Documentation/BASIC Guide/Documents|Working with Documents]]
<div id="docs" style="display:{{{docs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/StarDesktop|The StarDesktop]]
* [[Documentation/BASIC Guide/Templates|Templates]]
</div>
* [[Documentation/BASIC Guide/Text Documents|Text Documents]]
<div id="textdocs" style="display:{{{textdocs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Text Documents|The Structure of Text Documents]]
* [[Documentation/BASIC Guide/Editing Text Documents|Editing Text Documents]]
* [[Documentation/BASIC Guide/More Than Text|More than Just Text]]
</div>
* [[Documentation/BASIC Guide/Spreadsheets|Spreadsheet Documents]]
<div id="spread" style="display:{{{spread|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Spreadsheets|The Structure of Spreadsheets]]
** [[Documentation/BASIC Guide/Rows and Columns|Rows and Columns]]
** [[Documentation/BASIC Guide/Cells and Ranges|Cells and Ranges]]
** [[Documentation/BASIC Guide/Formatting Spreadsheet Documents|Formatting Spreadsheet Documents]]
* [[Documentation/BASIC Guide/Editing Spreadsheet Documents|Editing Spreadsheet Documents]]
</div>
* [[Documentation/BASIC Guide/Drawings Presentations|绘图和演示]]
<div id="draw" style="display:{{{draw|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Drawings|The Structure of Drawings]]
* [[Documentation/BASIC Guide/Editing Drawing Objects|Editing Drawing Objects]]
* [[Documentation/BASIC Guide/Presentations|Presentations]]
</div>
* [[Documentation/BASIC Guide/Charts|Charts (Diagrams)]]
<div id="chart" style="display:{{{chart|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Charts in Spreadsheets|Using Charts in Spreadsheets]]
* [[Documentation/BASIC Guide/Structure of Charts|The Structure of Charts]]
* [[Documentation/BASIC Guide/Chart Types|Chart Types]]
</div>
* [[Documentation/BASIC Guide/Database|Databases]]
<div id="base" style="display:{{{base|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/SQL|SQL: a Query Language]]
* [[Documentation/BASIC Guide/Database Access Types|Types of Database Access]]
* [[Documentation/BASIC Guide/Data Sources|Data Sources]]
* [[Documentation/BASIC Guide/Database Access|Database Access]]
</div>
* [[Documentation/BASIC Guide/Dialogs|Dialogs]]
<div id="dial" style="display:{{{dial|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Dialogs|Working With Dialogs]]
* [[Documentation/BASIC Guide/Properties|Properties]]
* [[Documentation/BASIC Guide/Events|Events]]
* [[Documentation/BASIC Guide/Control Elements|Dialog Control Elements]]
</div>
* [[Documentation/BASIC Guide/Forms|Forms]]
<div id="form" style="display:{{{form|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Forms|Working With Forms]]
* [[Documentation/BASIC Guide/Control Element Forms|Control Element Forms]]
* [[Documentation/BASIC Guide/Database Forms|Database Forms]]
</div>
<section end=toccontent />}}

[[Category:Documentation/BASIC Guide]]

<noinclude>
[[Category:Exclude in print|{{PAGENAME}}]]

</noinclude>
[[Category:G11n Wiki Translation]]

G11NWIKITEST/Documentation/BASIC Guide/Strings

2009-09-17T07:32:18Z

G11nAutomation: Created page with '{{DISPLAYTITLE: 字符串变量}} {{Documentation/BASICGuideTOC/v2 |ShowPrevNext=block |ShowPrevPage=block |PrevPage=Documentation/BASIC Guide/Working With Variables |NextPage=Do…'

Template:G11NWIKITEST/Documentation/BASICGuideTOC/v2

2009-09-09T01:05:24Z

G11nAutomation:

{{Documentation/MasterTOC
|ShowPrevPage={{{ShowPrevPage}}}
|PrevPage={{{PrevPage}}}
|ShowNextPage={{{ShowNextPage}}}
|NextPage={{{NextPage}}}
|bookid=BASICGuide
|ShowParttitle=none
|ShowPrevPart=none
|ShowNextPart=none
|booktitle=[[G11NWIKITEST/Documentation/BASIC Guide|基本指南]]
|toccontent=<section begin=toccontent />
* [[G11NWIKITEST/Documentation/BASIC Guide/Language|多语言{{OOo}} Basic]]
<div id="lang" style="display:{{{lang|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Program Overview|基本程序概述]]
* [[Documentation/BASIC Guide/Working With Variables|利用变量工作]]
* [[Documentation/BASIC Guide/Strings|Strings]]
* [[Documentation/BASIC Guide/Numbers|Numbers]]
* [[Documentation/BASIC Guide/Boolean|Boolean Values]]
* [[Documentation/BASIC Guide/Date|Date and Time]]
* [[Documentation/BASIC Guide/Arrays|Arrays]]
* [[Documentation/BASIC Guide/Scope of Variables|Scope and Life Span of Variables]]
* [[Documentation/BASIC Guide/Constants|Constants]]
* [[Documentation/BASIC Guide/Operators|Operators]]
* [[Documentation/BASIC Guide/Branching|Branching]]
* [[Documentation/BASIC Guide/Loops|Loops]]
* [[Documentation/BASIC Guide/Procedures and Functions|Procedures and Functions]]
* [[Documentation/BASIC Guide/Error Handling|Error Handling]]
* [[Documentation/BASIC Guide/Other Instructions|Other Instructions]]
</div>
* [[Documentation/BASIC Guide/Runtime Library|Runtime Library中文]]
<div id="runtime" style="display:{{{runtime|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Conversion Functions (Runtime Library)|Conversion Functions]]
* [[Documentation/BASIC Guide/Strings (Runtime Library)|Strings]]
* [[Documentation/BASIC Guide/Date and Time (Runtime Library)|Date and Time]]
* [[Documentation/BASIC Guide/Files and Directories (Runtime Library)|Files and Directories]]
* [[Documentation/BASIC Guide/Message and Input Boxes (Runtime Library)|Message and Input Boxes]]
* [[Documentation/BASIC Guide/Other Functions (Runtime Library)|Other Functions]]
</div>
* [[Documentation/BASIC Guide/API Intro|介绍 API]]
<div id="api" style="display:{{{api|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/UNO|Universal Network Objects (UNO)]]
* [[Documentation/BASIC Guide/Properties and Methods (API)|Properties and Methods]]
* [[Documentation/BASIC Guide/Modules, Services and Interfaces|Modules, Services and Interfaces]]
* [[Documentation/BASIC Guide/UNO Tools|Tools for Working with UNO]]
* [[Documentation/BASIC Guide/Interface Overview|Overview of Central Interfaces]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Documents|参照文档工作]]
<div id="docs" style="display:{{{docs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/StarDesktop|The StarDesktop]]
* [[Documentation/BASIC Guide/Templates|模版]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Text Documents|文本文档]]
<div id="textdocs" style="display:{{{textdocs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Text Documents|The Structure of Text Documents]]
* [[Documentation/BASIC Guide/Editing Text Documents|Editing Text Documents]]
* [[Documentation/BASIC Guide/More Than Text|More than Just Text]]
</div>
* [[Documentation/BASIC Guide/Spreadsheets|数据表文档]]
<div id="spread" style="display:{{{spread|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Spreadsheets|The Structure of Spreadsheets]]
** [[Documentation/BASIC Guide/Rows and Columns|Rows and Columns]]
** [[Documentation/BASIC Guide/Cells and Ranges|Cells and Ranges]]
** [[Documentation/BASIC Guide/Formatting Spreadsheet Documents|Formatting Spreadsheet Documents]]
* [[Documentation/BASIC Guide/Editing Spreadsheet Documents|Editing Spreadsheet Documents]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Drawings Presentations|绘图和演示]]
<div id="draw" style="display:{{{draw|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Drawings|The Structure of Drawings]]
* [[Documentation/BASIC Guide/Editing Drawing Objects|Editing Drawing Objects]]
* [[Documentation/BASIC Guide/Presentations|Presentations]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Charts|Charts (Diagrams)]]
<div id="chart" style="display:{{{chart|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Charts in Spreadsheets|Using Charts in Spreadsheets]]
* [[Documentation/BASIC Guide/Structure of Charts|The Structure of Charts]]
* [[Documentation/BASIC Guide/Chart Types|图标类型]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Database|数据库]]
<div id="base" style="display:{{{base|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/SQL|SQL: a Query Language]]
* [[Documentation/BASIC Guide/Database Access Types|Types of Database Access]]
* [[Documentation/BASIC Guide/Data Sources|数据资源]]
* [[Documentation/BASIC Guide/Database Access|Database Access]]
</div>
* [[Documentation/BASIC Guide/Dialogs|Dialogs]]
<div id="dial" style="display:{{{dial|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Dialogs|Working With Dialogs]]
* [[Documentation/BASIC Guide/Properties|Properties]]
* [[Documentation/BASIC Guide/Events|Events]]
* [[Documentation/BASIC Guide/Control Elements|Dialog Control Elements]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Forms|Forms]]
<div id="form" style="display:{{{form|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Forms|Working With Forms]]
* [[Documentation/BASIC Guide/Control Element Forms|Control Element Forms]]
* [[Documentation/BASIC Guide/Database Forms|Database Forms]]
</div>
<section end=toccontent />}}

[[Category:Documentation/BASIC Guide]]

<noinclude>
[[Category:Exclude in print|{{PAGENAME}}]]

</noinclude>[[Category:G11n Wiki Translation Testing]]

Template:G11NWIKITEST/Documentation/BASICGuideTOC/v2

2009-09-09T01:02:41Z

G11nAutomation:

{{Documentation/MasterTOC
|ShowPrevPage={{{ShowPrevPage}}}
|PrevPage={{{PrevPage}}}
|ShowNextPage={{{ShowNextPage}}}
|NextPage={{{NextPage}}}
|bookid=BASICGuide
|ShowParttitle=none
|ShowPrevPart=none
|ShowNextPart=none
|booktitle=[[Documentation/BASIC Guide|基本指南]]
|toccontent=<section begin=toccontent />
* [[Documentation/BASIC Guide/Language|多语言{{OOo}} Basic]]
<div id="lang" style="display:{{{lang|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Program Overview|基本程序概述]]
* [[Documentation/BASIC Guide/Working With Variables|利用变量工作]]
* [[Documentation/BASIC Guide/Strings|Strings]]
* [[Documentation/BASIC Guide/Numbers|Numbers]]
* [[Documentation/BASIC Guide/Boolean|Boolean Values]]
* [[Documentation/BASIC Guide/Date|Date and Time]]
* [[Documentation/BASIC Guide/Arrays|Arrays]]
* [[Documentation/BASIC Guide/Scope of Variables|Scope and Life Span of Variables]]
* [[Documentation/BASIC Guide/Constants|Constants]]
* [[Documentation/BASIC Guide/Operators|Operators]]
* [[Documentation/BASIC Guide/Branching|Branching]]
* [[Documentation/BASIC Guide/Loops|Loops]]
* [[Documentation/BASIC Guide/Procedures and Functions|Procedures and Functions]]
* [[Documentation/BASIC Guide/Error Handling|Error Handling]]
* [[Documentation/BASIC Guide/Other Instructions|Other Instructions]]
</div>
* [[Documentation/BASIC Guide/Runtime Library|Runtime Library中文]]
<div id="runtime" style="display:{{{runtime|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Conversion Functions (Runtime Library)|Conversion Functions]]
* [[Documentation/BASIC Guide/Strings (Runtime Library)|Strings]]
* [[Documentation/BASIC Guide/Date and Time (Runtime Library)|Date and Time]]
* [[Documentation/BASIC Guide/Files and Directories (Runtime Library)|Files and Directories]]
* [[Documentation/BASIC Guide/Message and Input Boxes (Runtime Library)|Message and Input Boxes]]
* [[Documentation/BASIC Guide/Other Functions (Runtime Library)|Other Functions]]
</div>
* [[Documentation/BASIC Guide/API Intro|介绍 API]]
<div id="api" style="display:{{{api|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/UNO|Universal Network Objects (UNO)]]
* [[Documentation/BASIC Guide/Properties and Methods (API)|Properties and Methods]]
* [[Documentation/BASIC Guide/Modules, Services and Interfaces|Modules, Services and Interfaces]]
* [[Documentation/BASIC Guide/UNO Tools|Tools for Working with UNO]]
* [[Documentation/BASIC Guide/Interface Overview|Overview of Central Interfaces]]
</div>
* [[Documentation/BASIC Guide/Documents|参照文档工作]]
<div id="docs" style="display:{{{docs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/StarDesktop|The StarDesktop]]
* [[Documentation/BASIC Guide/Templates|模版]]
</div>
* [[Documentation/BASIC Guide/Text Documents|文本文档]]
<div id="textdocs" style="display:{{{textdocs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Text Documents|The Structure of Text Documents]]
* [[Documentation/BASIC Guide/Editing Text Documents|Editing Text Documents]]
* [[Documentation/BASIC Guide/More Than Text|More than Just Text]]
</div>
* [[Documentation/BASIC Guide/Spreadsheets|数据表文档]]
<div id="spread" style="display:{{{spread|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Spreadsheets|The Structure of Spreadsheets]]
** [[Documentation/BASIC Guide/Rows and Columns|Rows and Columns]]
** [[Documentation/BASIC Guide/Cells and Ranges|Cells and Ranges]]
** [[Documentation/BASIC Guide/Formatting Spreadsheet Documents|Formatting Spreadsheet Documents]]
* [[Documentation/BASIC Guide/Editing Spreadsheet Documents|Editing Spreadsheet Documents]]
</div>
* [[Documentation/BASIC Guide/Drawings Presentations|绘图和演示]]
<div id="draw" style="display:{{{draw|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Drawings|The Structure of Drawings]]
* [[Documentation/BASIC Guide/Editing Drawing Objects|Editing Drawing Objects]]
* [[Documentation/BASIC Guide/Presentations|Presentations]]
</div>
* [[Documentation/BASIC Guide/Charts|Charts (Diagrams)]]
<div id="chart" style="display:{{{chart|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Charts in Spreadsheets|Using Charts in Spreadsheets]]
* [[Documentation/BASIC Guide/Structure of Charts|The Structure of Charts]]
* [[Documentation/BASIC Guide/Chart Types|图标类型]]
</div>
* [[Documentation/BASIC Guide/Database|数据库]]
<div id="base" style="display:{{{base|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/SQL|SQL: a Query Language]]
* [[Documentation/BASIC Guide/Database Access Types|Types of Database Access]]
* [[Documentation/BASIC Guide/Data Sources|数据资源]]
* [[Documentation/BASIC Guide/Database Access|Database Access]]
</div>
* [[Documentation/BASIC Guide/Dialogs|Dialogs]]
<div id="dial" style="display:{{{dial|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Dialogs|Working With Dialogs]]
* [[Documentation/BASIC Guide/Properties|Properties]]
* [[Documentation/BASIC Guide/Events|Events]]
* [[Documentation/BASIC Guide/Control Elements|Dialog Control Elements]]
</div>
* [[Documentation/BASIC Guide/Forms|Forms]]
<div id="form" style="display:{{{form|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Forms|Working With Forms]]
* [[Documentation/BASIC Guide/Control Element Forms|Control Element Forms]]
* [[Documentation/BASIC Guide/Database Forms|Database Forms]]
</div>
<section end=toccontent />}}

[[Category:Documentation/BASIC Guide]]

<noinclude>
[[Category:Exclude in print|{{PAGENAME}}]]

</noinclude>[[Category:G11n Wiki Translation Testing]]

Template:G11ntest/Documentation/BASICGuideTOC/v2

2009-09-08T19:29:31Z

G11nAutomation:

{{Documentation/Banner}}
__NOTOC__
{{ZH/Documentation/MasterTOC
|ShowPrevPage={{{ShowPrevPage}}}
|PrevPage={{{PrevPage}}}
|ShowNextPage={{{ShowNextPage}}}
|NextPage={{{NextPage}}}
|bookid=BASICGuide
|ShowParttitle=none
|ShowPrevPart=none
|ShowNextPart=none
|booktitle=[[ZH/Documentation/BASIC Guide|{{OOo}} BASIC 编程指南]]
|toccontent=<section begin=toccontent />
* [[Documentation/BASIC Guide/Language|{{OOo}} BASIC 语言]]
<div id="lang" style="display:{{{lang|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Program Overview|{{OOo}} Basic 程序概述]]
* [[Documentation/BASIC Guide/Working With Variables|使用变量]]
* [[Documentation/BASIC Guide/Strings|字符串变量]]
* [[Documentation/BASIC Guide/Numbers|数字变量]]
* [[g11ntest/Documentation/BASIC Guide/Boolean|布尔变量]]
* [[Documentation/BASIC Guide/Date|日期和时间变量]]
* [[g11ntest/Documentation/BASIC Guide/Arrays|数组]]
* [[Documentation/BASIC Guide/Scope of Variables|变量的作用域和生命周期]]
* [[Documentation/BASIC Guide/Constants|常量]]
* [[Documentation/BASIC Guide/Operators|运算符]]
* [[g11ntest/Documentation/BASIC Guide/Branching|分支]]
* [[ZH/Documentation/BASIC Guide/Loops|循环]]
* [[ZH/Documentation/BASIC Guide/Procedures and Functions|过程和函数]]
* [[ZH/Documentation/BASIC Guide/Error Handling|错误处理]]
</div>
* [[ZH/Documentation/BASIC Guide/Runtime Library|{{OOo}} Basic 的运行时库]]
<div id="runtime" style="display:{{{runtime|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/Conversion Functions (Runtime Library)|转换函数（{{OOo}} 运行时库）]]
* [[ZH/Documentation/BASIC Guide/Strings (Runtime Library)|字符串（{{OOo}} BASIC 运行时库）]]
* [[ZH/Documentation/BASIC Guide/Date and Time (Runtime Library)|日期和时间（{{OOo}} 运行时库）]]
* [[ZH/Documentation/BASIC Guide/Files and Directories (Runtime Library)|文件和目录（{{OOo}} 运行时库）]]
* [[ZH/Documentation/BASIC Guide/Message and Input Boxes (Runtime Library)|消息和输入框（{{OOo}} 运行时库）]]
* [[ZH/Documentation/BASIC Guide/Other Functions (Runtime Library)|其他函数（{{OOo}} 运行时库）]]
</div>
* [[ZH/Documentation/BASIC Guide/API Intro|{{OOo}} API 简介]]
<div id="api" style="display:{{{api|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/UNO|通用网络对象 (Universal Network Objects, UNO)]]
* [[ZH/Documentation/BASIC Guide/Properties and Methods (API)|属性和方法 (API)]]
* [[ZH/Documentation/BASIC Guide/Modules, Services and Interfaces|模块、服务和接口]]
* [[ZH/Documentation/BASIC Guide/UNO Tools|使用 UNO 时所需的工具]]
* [[ZH/Documentation/BASIC Guide/Interface Overview|几个主要接口的概述]]
</div>
* [[ZH/Documentation/BASIC Guide/Documents|使用 {{OOo}} 文档]]
<div id="docs" style="display:{{{docs|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/StarDesktop|StarDesktop]]
* [[ZH/Documentation/BASIC Guide/Templates|模板]]
</div>
* [[ZH/Documentation/BASIC Guide/Text Documents|文本文档]]
<div id="textdocs" style="display:{{{textdocs|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/Structure of Text Documents|文本文档结构]]
* [[ZH/Documentation/BASIC Guide/Editing Text Documents|编辑文本文档]]
* [[ZH/Documentation/BASIC Guide/More Than Text| 文本文档：文本以外的内容]]
</div>
* [[ZH/Documentation/BASIC Guide/Spreadsheets|电子表格]]
<div id="spread" style="display:{{{spread|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/Structure of Spreadsheets|电子表格文档结构]]
** [[ZH/Documentation/BASIC Guide/Rows and Columns|行和列]]
** [[ZH/Documentation/BASIC Guide/Cells and Ranges|单元格和区域]]
** [[ZH/Documentation/BASIC Guide/Formatting Spreadsheet Documents|设置电子表格文档格式]]
* [[ZH/Documentation/BASIC Guide/Editing Spreadsheet Documents|编辑电子表格文档]]
</div>
* [[ZH/Documentation/BASIC Guide/Drawings Presentations|绘图和演示文稿]]
<div id="draw" style="display:{{{draw|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/Structure of Drawings|绘图结构]]
* [[ZH/Documentation/BASIC Guide/Editing Drawing Objects|编辑绘图对象]]
* [[ZH/Documentation/BASIC Guide/Presentations|演示文稿]]
</div>
* [[ZH/Documentation/BASIC Guide/Charts|图表]]
<div id="chart" style="display:{{{chart|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/Charts in Spreadsheets|在电子表格中使用图表]]
* [[ZH/Documentation/BASIC Guide/Structure of Charts|图表结构]]
* [[ZH/Documentation/BASIC Guide/Chart Types|图表类型]]
</div>
* [[ZH/Documentation/BASIC Guide/Database|数据库]]
<div id="base" style="display:{{{base|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/SQL|SQL: 查询语言]]
* [[ZH/Documentation/BASIC Guide/Database Access Types|数据库访问类型]]
* [[ZH/Documentation/BASIC Guide/Data Sources|数据源]]
* [[ZH/Documentation/BASIC Guide/Database Access|数据库访问]]
</div>
* [[ZH/Documentation/BASIC Guide/Dialogs|对话框]]
<div id="dial" style="display:{{{dial|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/Working With Dialogs|使用对话框]]
* [[ZH/Documentation/BASIC Guide/Properties|属性]]
* [[ZH/Documentation/BASIC Guide/Events|事件]]
* [[ZH/Documentation/BASIC Guide/Control Elements|对话框控制元素详述]]
</div>
* [[ZH/Documentation/BASIC Guide/Forms|表单]]
<div id="form" style="display:{{{form|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/Working With Forms|使用表单]]
* [[ZH/Documentation/BASIC Guide/Control Element Forms|控制元素表单详述]]
* [[ZH/Documentation/BASIC Guide/Database Forms|数据库表单]]
</div>
<section end=toccontent />}}

[[Category:Documentation/BASIC Guide]]

G11NWIKITEST/Documentation/BASIC Guide

2009-09-08T19:28:39Z

G11nAutomation:

{{G11NWIKITEST/Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=none
|NextPage=Documentation/BASIC Guide/Language
}}
{{DISPLAYTITLE:{{OOo}} 中文BASIC Programming Guide}}
__NOTOC__
{{Download_Collection|MediaWiki:Collections/BASIC_Guide}}

中文 This guide provides an introduction to programming with {{OOo}} Basic. 中文 To get the most out of this book, you should be familiar with other programming languages. 中文 Extensive examples are provided to help you quickly develop your own {{OOo}} Basic programs.

中文 This guide divides information about {{OOo}} administration into several chapters. 中文 The first three chapters introduce you to {{OOo}} Basic:

* [[G11NWIKITEST/Documentation/BASIC Guide/Language|The Language of {{OOo}} Basic]]
* [[Documentation/BASIC Guide/Runtime_Library|Runtime Library]]
* [[Documentation/BASIC Guide/API_Intro|Introduction to the API]]

中文 These chapters provide an overview of {{OOo}} Basic and should be read by anyone who intends to write {{OOo}} Basic programs. 中文 The remaining chapters describe the individual components of the {{OOo}} API in more detail and can be read selectively as required:

* [[G11NWIKITEST/Documentation/BASIC Guide/Documents|Working with Documents]]
* [[G11NWIKITEST/Documentation/BASIC Guide/Text Documents|Text Documents]]
* [[Documentation/BASIC Guide/Spreadsheets|Spreadsheet Documents]]
* [[G11NWIKITEST/Documentation/BASIC Guide/Drawings Presentations|Drawings and Presentations]]
* [[G11NWIKITEST/Documentation/BASIC Guide/Charts|Charts (Diagrams)]]
* [[G11NWIKITEST/Documentation/BASIC Guide/Database|Databases]]
* [[Documentation/BASIC Guide/Dialogs|Dialogs]]
* [[G11NWIKITEST/Documentation/BASIC Guide/Forms|Forms]]

==中文 About {{OOo}} Basic==

中文 The {{OOo}} Basic programming language has been developed especially for {{OOo}} and is firmly integrated in the Office package.

中文 As the name suggests, {{OOo}} Basic is a programming language from the Basic family. Anyone who has previously worked with other Basic languages — in particular with Visual Basic or Visual Basic for Applications (VBA) from Microsoft — will quickly become accustomed to {{OOo}} Basic. Large sections of the basic constructs of {{OOo}} Basic are compatible with Visual Basic.

The {{OOo}} Basic programming language can be divided into four components:

* The language of {{OOo}} Basic: Defines the elementary linguistic constructs, for example, for variable declarations, loops, and functions.
* The runtime library: Provides standard functions which have no direct reference to {{OOo}}, for example, functions for editing numbers, strings, date values, and files.
* The {{OOo}} API (Application Programming Interface): Permits access to {{OOo}} documents and allows these to be created, saved, modified, and printed.
* The Dialog Editor: Creates personal dialog windows and provides scope for the adding of control elements and event handlers.

{{Documentation/Note|Compatibility between {{OOo}} Basic and VBA relates to the {{OOo}} Basic language as well as the runtime library. The {{OOo}} API and the Dialog Editor are not compatible with VBA (standardizing these interfaces would have made many of the concepts provided in {{OOo}} impossible).}}

==Intended Users of {{OOo}} Basic==

The scope of application for {{OOo}} Basic begins where the standard functions of {{OOo}} end. Routine tasks can therefore be automated in {{OOo}} Basic, links can be made to other programs — for example to a database server — and complex activities can be performed at the press of a button by using predefined scripts.

{{OOo}} Basic offers complete access to all {{OOo}} functions, supports all functions, modifies document types, and provides options for creating personal dialog windows.

==Use of {{OOo}} Basic==

{{OOo}} Basic can be used by any {{OOo}} user without any additional programs or aids. Even in the standard installation, {{OOo}} Basic has all the components needed to create its own Basic macros, including:

* The integrated development environment (IDE) which provides an editor for creating and testing macros.
* The interpreter, which is needed to run {{OOo}} Basic macros.
* The interfaces to various {{OOo}} applications, which allow for direct access to Office documents.

==More Information==

The components of the {{OOo}} API that are discussed in this guide were selected based on their practical benefits for the {{OOo}} Basic programmer. In general, only parts of the interfaces are discussed. For a more detailed picture, see [http://api.openoffice.org/docs/common/ref/com/sun/star/module-ix.html the API reference].

The [[Documentation/DevGuide/OpenOffice.org_Developers_Guide|Developer's Guide]] describes the {{OOo}} API in more detail than this guide, but is primarily intended for Java and C++ programmers. Anyone who is already familiar with {{OOo}} Basic programming can find additional information in the Developer's Guide on {{OOo}} Basic and {{OOo}} programming.

Programmers who want to work directly with Java or C++ rather than {{OOo}} Basic should consult the {{OOo}} Developer's Guide instead of this guide. {{OOo}} programming with Java or C++ is a considerably more complex process than programming with {{OOo}} Basic.

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide}}

{{PDL1}}[[Category:G11n Wiki Translation Testing]]

Template:G11ntest/Documentation/BASICGuideTOC/v2

2009-09-08T19:27:16Z

G11nAutomation:

{{Documentation/Banner}}
__NOTOC__
{{ZH/Documentation/MasterTOC
|ShowPrevPage={{{ShowPrevPage}}}
|PrevPage={{{PrevPage}}}
|ShowNextPage={{{ShowNextPage}}}
|NextPage={{{NextPage}}}
|bookid=BASICGuide
|ShowParttitle=none
|ShowPrevPart=none
|ShowNextPart=none
|booktitle=[[ZH/Documentation/BASIC Guide|{{OOo}} BASIC 编程指南]]
|toccontent=<section begin=toccontent />
* [[Documentation/BASIC Guide/Language|{{OOo}} BASIC 语言]]
<div id="lang" style="display:{{{lang|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Program Overview|{{OOo}} Basic 程序概述]]
* [[Documentation/BASIC Guide/Working With Variables|使用变量]]
* [[Documentation/BASIC Guide/Strings|字符串变量]]
* [[Documentation/BASIC Guide/Numbers|数字变量]]
* [[Documentation/BASIC Guide/Boolean|布尔变量]]
* [[Documentation/BASIC Guide/Date|日期和时间变量]]
* [[Documentation/BASIC Guide/Arrays|数组]]
* [[Documentation/BASIC Guide/Scope of Variables|变量的作用域和生命周期]]
* [[Documentation/BASIC Guide/Constants|常量]]
* [[Documentation/BASIC Guide/Operators|运算符]]
* [[Documentation/BASIC Guide/Branching|分支]]
* [[ZH/Documentation/BASIC Guide/Loops|循环]]
* [[ZH/Documentation/BASIC Guide/Procedures and Functions|过程和函数]]
* [[ZH/Documentation/BASIC Guide/Error Handling|错误处理]]
</div>
* [[ZH/Documentation/BASIC Guide/Runtime Library|{{OOo}} Basic 的运行时库]]
<div id="runtime" style="display:{{{runtime|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/Conversion Functions (Runtime Library)|转换函数（{{OOo}} 运行时库）]]
* [[ZH/Documentation/BASIC Guide/Strings (Runtime Library)|字符串（{{OOo}} BASIC 运行时库）]]
* [[ZH/Documentation/BASIC Guide/Date and Time (Runtime Library)|日期和时间（{{OOo}} 运行时库）]]
* [[ZH/Documentation/BASIC Guide/Files and Directories (Runtime Library)|文件和目录（{{OOo}} 运行时库）]]
* [[ZH/Documentation/BASIC Guide/Message and Input Boxes (Runtime Library)|消息和输入框（{{OOo}} 运行时库）]]
* [[ZH/Documentation/BASIC Guide/Other Functions (Runtime Library)|其他函数（{{OOo}} 运行时库）]]
</div>
* [[ZH/Documentation/BASIC Guide/API Intro|{{OOo}} API 简介]]
<div id="api" style="display:{{{api|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/UNO|通用网络对象 (Universal Network Objects, UNO)]]
* [[ZH/Documentation/BASIC Guide/Properties and Methods (API)|属性和方法 (API)]]
* [[ZH/Documentation/BASIC Guide/Modules, Services and Interfaces|模块、服务和接口]]
* [[ZH/Documentation/BASIC Guide/UNO Tools|使用 UNO 时所需的工具]]
* [[ZH/Documentation/BASIC Guide/Interface Overview|几个主要接口的概述]]
</div>
* [[ZH/Documentation/BASIC Guide/Documents|使用 {{OOo}} 文档]]
<div id="docs" style="display:{{{docs|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/StarDesktop|StarDesktop]]
* [[ZH/Documentation/BASIC Guide/Templates|模板]]
</div>
* [[ZH/Documentation/BASIC Guide/Text Documents|文本文档]]
<div id="textdocs" style="display:{{{textdocs|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/Structure of Text Documents|文本文档结构]]
* [[ZH/Documentation/BASIC Guide/Editing Text Documents|编辑文本文档]]
* [[ZH/Documentation/BASIC Guide/More Than Text| 文本文档：文本以外的内容]]
</div>
* [[ZH/Documentation/BASIC Guide/Spreadsheets|电子表格]]
<div id="spread" style="display:{{{spread|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/Structure of Spreadsheets|电子表格文档结构]]
** [[ZH/Documentation/BASIC Guide/Rows and Columns|行和列]]
** [[ZH/Documentation/BASIC Guide/Cells and Ranges|单元格和区域]]
** [[ZH/Documentation/BASIC Guide/Formatting Spreadsheet Documents|设置电子表格文档格式]]
* [[ZH/Documentation/BASIC Guide/Editing Spreadsheet Documents|编辑电子表格文档]]
</div>
* [[ZH/Documentation/BASIC Guide/Drawings Presentations|绘图和演示文稿]]
<div id="draw" style="display:{{{draw|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/Structure of Drawings|绘图结构]]
* [[ZH/Documentation/BASIC Guide/Editing Drawing Objects|编辑绘图对象]]
* [[ZH/Documentation/BASIC Guide/Presentations|演示文稿]]
</div>
* [[ZH/Documentation/BASIC Guide/Charts|图表]]
<div id="chart" style="display:{{{chart|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/Charts in Spreadsheets|在电子表格中使用图表]]
* [[ZH/Documentation/BASIC Guide/Structure of Charts|图表结构]]
* [[ZH/Documentation/BASIC Guide/Chart Types|图表类型]]
</div>
* [[ZH/Documentation/BASIC Guide/Database|数据库]]
<div id="base" style="display:{{{base|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/SQL|SQL: 查询语言]]
* [[ZH/Documentation/BASIC Guide/Database Access Types|数据库访问类型]]
* [[ZH/Documentation/BASIC Guide/Data Sources|数据源]]
* [[ZH/Documentation/BASIC Guide/Database Access|数据库访问]]
</div>
* [[ZH/Documentation/BASIC Guide/Dialogs|对话框]]
<div id="dial" style="display:{{{dial|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/Working With Dialogs|使用对话框]]
* [[ZH/Documentation/BASIC Guide/Properties|属性]]
* [[ZH/Documentation/BASIC Guide/Events|事件]]
* [[ZH/Documentation/BASIC Guide/Control Elements|对话框控制元素详述]]
</div>
* [[ZH/Documentation/BASIC Guide/Forms|表单]]
<div id="form" style="display:{{{form|none}}};margin-left: 12px;">
* [[ZH/Documentation/BASIC Guide/Working With Forms|使用表单]]
* [[ZH/Documentation/BASIC Guide/Control Element Forms|控制元素表单详述]]
* [[ZH/Documentation/BASIC Guide/Database Forms|数据库表单]]
</div>
<section end=toccontent />}}

[[Category:Documentation/BASIC Guide]]

G11ntest/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Structure of Charts

2009-09-08T19:23:04Z

G11nAutomation:

{{g11ntest/Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Charts in Spreadsheets
|NextPage=Documentation/BASIC Guide/Chart Types
|chart=block
}}
{{DISPLAYTITLE:The Structure of Charts}}

__NOTOC__
The structure of a chart, and therefore the list of services and interfaces supported by it, depends on the chart type. For example, the methods and properties of the Z-axis, are available in 3D charts, but not in 2D charts, and in pie charts, there are no interfaces for working with axes.

== Title, Subtitle and Legend ==

Title, subtitle and legend are basic elements provided for every chart. The <tt>Chart</tt> object provides the following properties for administrating these elements:

;<tt>HasMainTitle (Boolean)</tt>:activates the title
;<tt>Title (Object)</tt>:object with detailed information about the chart title (supports the <idl>com.sun.star.chart.ChartTitle</idl> service)
;<tt>HasSubTitle(Boolean)</tt>:activates the subtitle
;<tt>Subtitle (Object)</tt>:object with detailed information about the chart subtitle (supports the <idl>com.sun.star.chart.ChartTitle</idl> service)
;<tt>HasLegend (Boolean)</tt>:activates the legend
;<tt>Legend (Object)</tt>:object with detailed information about the legend (supports the <idl>com.sun.star.chart.ChartLegend</idl> service)

Both services <tt>com.sun.star.chart.ChartTitle</tt> and <tt>com.sun.star.chart.ChartLegend</tt> do support the service <tt>com.sun.star.drawing.Shape</tt>. This allows to determine the position and size of the elements using the <tt>Position</tt> and <tt>Size</tt> properties. As the size of the legend and the titles is calculated automatically based on the current content and the character height for example, the size property provides read access only.

Fill and line properties (<idl>com.sun.star.drawing.FillProperties</idl> and <idl>com.sun.star.drawing.LineProperties</idl> services) as well as the character properties (<idl>com.sun.star.style.CharacterProperties</idl> service) are provided for further formatting of the elements.

<idl>com.sun.star.chart.ChartTitle</idl> contains not only the listed formatting properties, but also two other properties:

;<tt>String (String)</tt>:text which to be displayed as the title or subtitle
;<tt>TextRotation (Long)</tt>:angle of rotation of text in 100ths of a degree

The legend (<idl>com.sun.star.chart.ChartLegend</idl>) contains the following additional property:

;<tt>Alignment (Enum)</tt>:position at which the legend appears (value of type <idl>com.sun.star.chart.ChartLegendPosition</idl>)

The following example creates a chart with a title "Main Title String", a subtitle "Subtitle String" and a legend. The legend has a gray background color, is placed at the bottom of the chart, and has a character size of 7 points.

<source lang="oobas">
Dim Doc As Object
Dim Charts As Object
Dim Chart as Object
Dim Rect As New com.sun.star.awt.Rectangle
Dim RangeAddress(0) As New com.sun.star.table.CellRangeAddress

Rect.X = 8000
Rect.Y = 1000
Rect.Width = 10000
Rect.Height = 7000
RangeAddress(0).Sheet = 0
RangeAddress(0).StartColumn = 0
RangeAddress(0).StartRow = 0
RangeAddress(0).EndColumn = 2
RangeAddress(0).EndRow = 12

Doc = StarDesktop.CurrentComponent

Charts = Doc.Sheets(0).Charts
Charts.addNewByName("MyChart", Rect, RangeAddress(), True, True)
Chart = Charts.getByName("MyChart").EmbeddedObject
Chart.HasMainTitle = True
Chart.Title.String = "Main Title String"
Chart.HasSubTitle = True
Chart.Subtitle.String = "Subtitle String"
Chart.HasLegend = True
Chart.Legend.Alignment = com.sun.star.chart.ChartLegendPosition.BOTTOM
Chart.Legend.FillStyle = com.sun.star.drawing.FillStyle.SOLID
Chart.Legend.FillColor = RGB(210, 210, 210)
Chart.Legend.CharHeight = 7
</source>

== Background ==

Every chart has a background area. The <tt>Chart</tt> object provides the property <tt>Area</tt> to format the background:

;<tt>Area (Object)</tt>:background area of the chart (supports <idl>com.sun.star.chart.ChartArea</idl> service)

The background of a chart covers its complete area, including the area under the title, subtitle and legend. The associated <idl>com.sun.star.chart.ChartArea</idl> service supports line and fill properties.

== Diagram ==

The <tt>Chart</tt> object provides the property <tt>Diagram</tt> which forms the coordinate system with axes and grids, where the data finally is displayed:

;<tt>Diagram (Object)</tt>:object forming the coordinate system where the data is plotted. It supports <idl>com.sun.star.chart.Diagram</idl> service and:
:* <idl>com.sun.star.chart.StackableDiagram</idl>
:* <idl>com.sun.star.chart.ChartAxisXSupplier</idl>
:* <idl>com.sun.star.chart.ChartAxisYSupplier</idl>
:* <idl>com.sun.star.chart.ChartAxisZSupplier</idl>
:* <idl>com.sun.star.chart.ChartTwoAxisXSupplier</idl>
:* <idl>com.sun.star.chart.ChartTwoAxisYSupplier</idl>

Different services are supported depending on the chart type (see
[[g11ntest/Documentation/BASIC_Guide/Chart_Types|Chart Types]]).

== Wall and Floor ==

The chart wall is the background of the coordinate system where the data is plotted.
Two chart walls usually exist for 3D charts: one behind the plotted data and one as the left-hand or right-hand demarcation. This depends on the rotation of the chart. 3D charts usually also have a floor.

The <tt>Diagram</tt> object provides the properties Wall and Floor:

;<tt>Wall (Object)</tt>:background wall of the coordinate system (supports <idl>com.sun.star.chart.ChartArea</idl> service)
;<tt>Floor (Object)</tt>:floor panel of coordinate system (only for 3D charts, supports <idl>com.sun.star.chart.ChartArea</idl> service)

The specified objects support the <tt>com.sun.star.chart.ChartArea</tt> service, which provides the usual fill and line properties (<idl>com.sun.star.drawing.FillProperties</idl> and <idl>com.sun.star.drawing.LineProperties</idl> services, refer to [[Documentation/BASIC_Guide/Drawings_Presentations|Drawings and Presentations]]).

The following example shows how graphics (named Sky) already contained in {{OOo}} can be used as a background for a chart. The wall is set to be blue.

<source lang="oobas">
Dim Doc As Object
Dim Charts As Object
Dim Chart as Object
Dim Rect As New com.sun.star.awt.Rectangle
Dim RangeAddress(0) As New com.sun.star.table.CellRangeAddress

Rect.X = 8000
Rect.Y = 1000
Rect.Width = 10000
Rect.Height = 7000
RangeAddress(0).Sheet = 0
RangeAddress(0).StartColumn = 0
RangeAddress(0).StartRow = 0
RangeAddress(0).EndColumn = 2
RangeAddress(0).EndRow = 12

Doc = StarDesktop.CurrentComponent

Charts = Doc.Sheets(0).Charts
Charts.addNewByName("MyChart", Rect, RangeAddress(), True, True)
Chart = Charts.getByName("MyChart").EmbeddedObject
Chart.Area.FillStyle = com.sun.star.drawing.FillStyle.BITMAP
Chart.Area.FillBitmapName = "Sky"
Chart.Area.FillBitmapMode = com.sun.star.drawing.BitmapMode.REPEAT

Chart.Diagram.Wall.FillStyle = com.sun.star.drawing.FillStyle.SOLID
Chart.Diagram.Wall.FillColor = RGB(00,132,209)
</source>

== Axes ==

{{OOo}} recognizes five different axes that can be used in a chart. In the simplest scenario, these are the X and Y-axes. When working with 3D charts, a Z-axis is also sometimes provided. For charts in which the values of the various rows of data deviate significantly from one another, {{OOo}} provides a second X and Y-axis for second scaling operations.

The <tt>Diagram</tt> object provides the following properties to access the axes:

;<tt>HasXAxis (Boolean)</tt>:activates the X-axis
;<tt>XAxis (Object)</tt>:object with detailed information about the X-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasXAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the X-axis

;<tt>HasYAxis (Boolean)</tt>:activates the Y-axis
;<tt>YAxis (Object)</tt>:object with detailed information about the Y-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasYAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the Y-axis

;<tt>HasZAxis (Boolean)</tt>:activates the Z-axis
;<tt>ZAxis (Object)</tt>:object with detailed information about the Z-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasZAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the Z-axis

;<tt>HasSecondaryXAxis (Boolean)</tt>:activates the secondary X-axis
;<tt>SecondaryXAxis (Object)</tt>:object with detailed information about the secondary X-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasSecondaryXAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the secondary X-axis

;<tt>HasSecondaryYAxis (Boolean)</tt>:activates the secondary Y-axis
;<tt>SecondaryYAxis (Object)</tt>:object with detailed information about the secondary Y-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasSecondaryYAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the secondary Y-axis

== Properties of Axes ==

The axis objects of a {{OOo}} chart support the <idl>com.sun.star.chart.ChartAxis</idl> service. In addition to the properties for characters <idl>(com.sun.star.style.CharacterProperties</idl> service, refer to [[Documentation/BASIC_Guide/Text_Documents|Text Documents]]) and lines <idl>(com.sun.star.drawing.LineStyle</idl> service, refer to [[Documentation/BASIC_Guide/Drawings_Presentations|Drawings and Presentations]]), it provides the following properties:

===Scaling properties:===
;<tt>Max (Double)</tt>:maximum value for axis
;<tt>Min (Double)</tt>:minimum value for axis
;<tt>Origin (Double)</tt>:point of intersect for crossing axes
;<tt>StepMain (Double)</tt>:distance between the major interval marks
;<tt>StepHelp (Double)</tt>:distance between the minor interval marks (deprecated since OpenOffice.org 3.0; Use property StepHelpCount instead)
;<tt>StepHelpCount (Long)</tt>:Contains the number of minor intervals within a major interval. E.g. a StepHelpCount of 5 divides the major interval into 5 pieces and thus produces 4 minor tick marks. (available since OpenOffice.org 3.0)
;<tt>AutoMax (Boolean)</tt>:the maximum value for the axis is calculated automatically when set to true
;<tt>AutoMin (Boolean)</tt>:the minimum value for the axis is calculated automatically when set to true
;<tt>AutoOrigin (Boolean)</tt>:the origin is determined automatically when set to true
;<tt>AutoStepMain (Boolean)</tt>:StepMain is determined automatically when set to true
;<tt>AutoStepHelp (Boolean)</tt>:StepHelpCount is determined automatically when set to true
;<tt>Logarithmic (Boolean)</tt>:scales the axes in logarithmic manner (rather than linear)
;<tt>ReverseDirection (Boolean)</tt>:determines if the axis orientation is mathematical or reversed. (available since OpenOffice.org 2.4)

===Label properties:===
;<tt>DisplayLabels (Boolean)</tt>:activates the text label at the interval marks
;<tt>TextRotation (Long)</tt>:angle of rotation of text label in 100ths of a degree
;<tt>ArrangeOrder (enum)</tt>:the label may be staggered, thus they are positioned alternately over two lines (values according to <idl>com.sun.star.chart.ChartAxisArrangeOrderType</idl>)
;<tt>TextBreak (Boolean)</tt>:permits line breaks within the axes labels
;<tt>TextCanOverlap (Boolean)</tt>:permits an overlap of the axes labels
;<tt>NumberFormat (Long)</tt>:number format to be used with the axes labels
;<tt>LinkNumberFormatToSource (Boolean)</tt>:determines whether to use the number format given by the container document, or from the property <tt>NumberFormat</tt>. (since OpenOffice.org 2.3)

===Interval mark properties:===
;<tt>Marks (Const)</tt>:determines the position of the major interval marks (values in accordance with <idl>com.sun.star.chart.ChartAxisMarks</idl>)
;<tt>HelpMarks (Const)</tt>:determines the position of the minor interval marks (values in accordance with <idl>com.sun.star.chart.ChartAxisMarks</idl>)

===Only for bar charts:===
;<tt>Overlap (Long)</tt>:percentage which specifies the extent to which the bars of different sets of data may overlap (at 100%, the bars are shown as completely overlapping, at -100%, there is a distance of the width of one bar between them)
;<tt>GapWidth (long)</tt>:percentage which specifies the distance there may be between the different groups of bars of a chart (at 100%, there is a distance corresponding to the width of one bar)

== Grids ==

For the primary axes grids and sub grids can be displayed, matching to the major and minor intervals.
The <tt>Diagram</tt> object provides the following properties to access the grids:

;<tt>HasXAxisGrid (Boolean)</tt>:activates major grid for X-axis
;<tt>XMainGrid (Object)</tt>:object with detailed information about the major grid for X-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)
;<tt>HasXAxisHelpGrid (Boolean)</tt>:activates minor grid for X-axis
;<tt>XHelpGrid (Object)</tt>:object with detailed information about the minor grid for X-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)

the same for y and z:

;<tt>HasYAxisGrid (Boolean)</tt>:activates major grid for Y-axis
;<tt>YMainGrid (Object)</tt>:object with detailed information about the major grid for Y-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)
;<tt>HasYAxisHelpGrid (Boolean)</tt>:activates minor grid for Y-axis
;<tt>YHelpGrid (Object)</tt>:object with detailed information about the minor grid for Y-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)

;<tt>HasZAxisGrid (Boolean)</tt>:activates major grid for Z-axis
;<tt>ZMainGrid (Object)</tt>:object with detailed information about the major grid for Z-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)
;<tt>HasZAxisHelpGrid (Boolean)</tt>:activates minor grid for Z-axis
;<tt>ZHelpGrid (Object)</tt>:object with detailed information about the minor grid for Z-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)

The grid object is based on the <idl>com.sun.star.chart.ChartGrid</idl> service, which in turn supports the line properties of the <idl>com.sun.star.drawing.LineStyle</idl> support service (refer to [[Documentation/BASIC_Guide/Drawings_Presentations|Drawings and Presentations]]).

== Axes Title ==

For all axes an additional title can be displayed.
The <tt>Diagram</tt> object provides the following properties to access the axes title:

;<tt>HasXAxisTitle (Boolean)</tt>:activates title of X-axis
;<tt>XAxisTitle (Object)</tt>:object with detailed information about title of the X-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

same y and z:

;<tt>HasYAxisTitle (Boolean)</tt>:activates title of Y-axis
;<tt>YAxisTitle (Object)</tt>:object with detailed information about title of the Y-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

;<tt>HasZAxisTitle (Boolean)</tt>:activates title of Z-axis
;<tt>ZAxisTitle (Object)</tt>:object with detailed information about title of the Z-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

and for the secondary axes (available since OpenOffice.org 3.0):

;<tt>HasSecondaryXAxisTitle (Boolean)</tt>:activates title of the secondary X-axis.
;<tt>SecondXAxisTitle (Object)</tt>:object with detailed information about title of the secondary X-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

;<tt>HasSecondaryYAxisTitle (Boolean)</tt>:activates title of the secondary Y-axis.
;<tt>SecondYAxisTitle (Object)</tt>:object with detailed information about title of the secondary Y-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

The objects for formatting the axes title are based on the <idl>com.sun.star.chart.ChartTitle</idl> service, which is also used for chart titles.

=== Example ===

The following example creates a line chart. The color for the rear wall of the chart is set to white. Both the X and Y-axes have a gray grid for visual orientation. The minimum value of the Y-axis is fixed to 0 and the maximum value is fixed to 100 so that the resolution of the chart is retained even if the values are changed. The X-axis points in reverse direction from right to left. And a title for the X-axis was added.

<source lang="oobas">
Dim Doc As Object
Dim Charts As Object
Dim Chart as Object
Dim Rect As New com.sun.star.awt.Rectangle
Dim RangeAddress(0) As New com.sun.star.table.CellRangeAddress

Doc = StarDesktop.CurrentComponent
Charts = Doc.Sheets(0).Charts

Rect.X = 8000
Rect.Y = 1000
Rect.Width = 10000
Rect.Height = 7000
RangeAddress(0).Sheet = 0
RangeAddress(0).StartColumn = 0
RangeAddress(0).StartRow = 0
RangeAddress(0).EndColumn = 2
RangeAddress(0).EndRow = 12

Charts.addNewByName("MyChart", Rect, RangeAddress(), True, True)
Chart = Charts.getByName("MyChart").embeddedObject
Chart.Diagram = Chart.createInstance("com.sun.star.chart.LineDiagram")
Chart.Diagram.Wall.FillColor = RGB(255, 255, 255)
Chart.Diagram.HasXAxisGrid = True
Chart.Diagram.XMainGrid.LineColor = RGB(192, 192, 192)
Chart.Diagram.HasYAxisGrid = True
Chart.Diagram.YMainGrid.LineColor = RGB(192, 192, 192)
Chart.Diagram.YAxis.Min = 0
Chart.Diagram.YAxis.Max = 100

Chart.Diagram.XAxis.ReverseDirection = true 'needs OpenOffice.org 2.4 or newer
Chart.Diagram.HasXAxisTitle = true
Chart.Diagram.XAxisTitle.String = "Reversed X Axis Example"
</source>

== 3D Charts ==

Most charts in {{OOo}} can also be displayed with 3D graphics. The following properties are provided for 3D charts at the <tt>Diagram</tt> object:

;<tt>Dim3D (Boolean)</tt>:activates 3D display
;<tt>Deep (Boolean)</tt>:the series will be arranged behind each other in z-direction
;<tt>RightAngledAxes (Boolean)</tt>:activates a 3D display mode where X- and Y-axes form a right angle within the projection. (available since OpenOffice.org 2.3)
;<tt>D3DScenePerspective (Enum)</tt>:defines whether the 3D objects are to be drawn in perspective or parallel projection.(values according to <idl>com.sun.star.drawing.ProjectionMode</idl>)
;<tt>Perspective (Long)</tt>:Perspective of 3D charts ( [0,100] ) (available since OpenOffice.org 2.4.1)
;<tt>RotationHorizontal (Long)</tt>:Horizontal rotation of 3D charts in degrees ( [-180,180] ) (available since OpenOffice.org 2.4.1)
;<tt>RotationVertical (Long)</tt>:Vertical rotation of 3D charts in degrees ( [-180,180] ) (available since OpenOffice.org 2.4.1)

The following example creates a 3D area chart.

<source lang="oobas">
Dim Doc As Object
Dim Charts As Object
Dim Chart as Object
Dim Rect As New com.sun.star.awt.Rectangle
Dim RangeAddress(0) As New com.sun.star.table.CellRangeAddress

Doc = StarDesktop.CurrentComponent
Charts = Doc.Sheets(0).Charts

Rect.X = 8000
Rect.Y = 1000
Rect.Width = 10000
Rect.Height = 7000
RangeAddress(0).Sheet = 0
RangeAddress(0).StartColumn = 0
RangeAddress(0).StartRow = 0
RangeAddress(0).EndColumn = 2
RangeAddress(0).EndRow = 12

Charts.addNewByName("MyChart", Rect, RangeAddress(), True, True)
Chart = Charts.getByName("MyChart").embeddedObject
Chart.Diagram = Chart.createInstance("com.sun.star.chart.AreaDiagram")
Chart.Diagram.Dim3D = true
Chart.Diagram.Deep = true
Chart.Diagram.RightAngledAxes = true 'needs OpenOffice.org 2.3 or newer
Chart.Diagram.D3DScenePerspective = com.sun.star.drawing.ProjectionMode.PERSPECTIVE
Chart.Diagram.Perspective = 100 'needs OpenOffice.org 2.4.1 or newer
Chart.Diagram.RotationHorizontal = 60 'needs OpenOffice.org 2.4.1 or newer
Chart.Diagram.RotationVertical = 30 'needs OpenOffice.org 2.4.1 or newer
</source>

== Stacked Charts ==

Stacked charts are charts that are arranged with several individual values on top of one another to produce a total value. This view shows not only the individual values, but also an overview of all the values.

In {{OOo}}, various types of charts can be displayed in a stacked form. All of these charts support the <idl>com.sun.star.chart.StackableDiagram</idl> service, which in turn provides the following properties:

;<tt>Stacked (Boolean)</tt>:activates the stacked viewing mode
;<tt>Percent (Boolean)</tt>:rather than absolute values, displays their percentage distribution

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide/Structure of Charts}}

{{PDL1}}[[Category:G11n Wiki Translation Testing]]

G11ntest/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Interface Overview

2009-09-08T19:22:51Z

G11nAutomation:

{{g11ntest/Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/UNO Tools
|NextPage=Documentation/BASIC Guide/Documents
|api=block
}}
{{DISPLAYTITLE:Overview of Some Central Interfaces}}

__NOTOC__
Some interfaces of {{OOo}} can be found in many parts of the {{OOo}} API. They define sets of methods for abstract tasks which can be applied to various problems. Here, you will find an overview of the most common of these interfaces.

The origin of the objects is explained at a later point in this guide. At this point, only some of the abstract aspects of objects, for which the {{OOo}} API provides some central interfaces, are discussed.

== Creating Context-Dependent Objects ==

The {{OOo}} API provides two options for creating objects. One can be found in the <tt>createUnoService</tt> function mentioned at the start of this chapter. <tt>createUnoService</tt> creates an object which can be used universally. Such objects and services are also known as context-independent services.

In addition to context-independent services, there are also context-dependent services whose objects are only useful when used in conjunction with another object. A drawing object for a spreadsheet document, for example, can therefore only exist in conjunction with this one document.

=== <tt>com.sun.star.lang.XMultiServiceFactory</tt> Interface ===

Context-dependent objects are usually created by means of an object method, on which the object depends. The <tt>createInstance</tt> method, which is defined in the <tt>XMultiServiceFactory</tt> interface, is used in particular in the document objects.

The drawing object can, for example, be created as follows using a spreadsheet object:

<source lang="oobas">
Dim RectangleShape As Object
RectangleShape = _
Spreadsheet.createInstance("com.sun.star.drawing.RectangleShape")
</source>

A paragraph template in a text document is created in the same way:

<source lang="oobas">
Dim Style as Object
Style = Textdocument.createInstance("com.sun.star.style.ParagraphStyle")
</source>

== Named Access to Subordinate Objects ==

The <tt>XNameAccess</tt> and <tt>XNameContainer</tt> interfaces are used in objects that contain subordinate objects, which can be addressed using a natural language name.

While <tt>XNamedAccess</tt> permits access to the individual objects, <tt>XNameContainer</tt> takes on the insertion, modification and deletion of elements.

=== <tt>com.sun.star.container.XNameAccess</tt> Interface ===

An example of the use of <tt>XNameAccess</tt> is provided by the <tt>sheets</tt> object of a spreadsheet. It combines all the pages within the spreadsheet. The individual pages are accessed from the <tt>sheets</tt> object, by using the <tt>getByName</tt> method from <tt>XNameAccess</tt>:

<source lang="oobas">
Dim Sheets As Object
Dim Sheet As Object

Sheets = Spreadsheet.Sheets
Sheet = Sheets.getByName("Sheet1")
</source>

The <tt>getElementNames</tt> method provides an overview of the names of all elements. As a result, it returns a data field containing the names. The following example shows how all element names of a spreadsheet can thereby be determined and displayed in a loop:

<source lang="oobas">
Dim Sheets As Object
Dim SheetNames
Dim I As Integer

Sheets = Spreadsheet.Sheets
SheetNames = Sheets.getElementNames

For I=LBound(SheetNames) To UBound(SheetNames)
MsgBox SheetNames(I)
Next I
</source>

The <tt>hasByName</tt> method of the <tt>XNameAccess</tt> interface reveals whether a subordinate object with a particular name exists within the basic object. The following example therefore displays a message that informs the user whether the <tt>Spreadsheet</tt> object contains a page of the name <tt>Sheet1</tt>.

<source lang="oobas">
Dim Sheets As Object

Sheets = Spreadsheet.Sheets
If Sheets.HasByName("Sheet1") Then
MsgBox " Sheet1 available"
Else
MsgBox "Sheet1 not available"
End If
</source>

=== <tt>com.sun.star.container.XNameContainer</tt> Interface ===

The <tt>XNameContainer</tt> interface takes on the insertion, deletion and modification of subordinate elements in a basic object. The functions responsible are <tt>insertByName</tt>, <tt>removeByName</tt> and <tt>replaceByName</tt>.

The following is a practical example of this. It calls a text document, which contains a <tt>StyleFamilies</tt> object and uses this to in turn make the paragraph templates (ParagraphStyles) of the document available.

<source lang="oobas">
Dim StyleFamilies As Object
Dim ParagraphStyles As Object
Dim NewStyle As Object

StyleFamilies = Textdoc.StyleFamilies
ParagraphStyles = StyleFamilies.getByName("ParagraphStyles")
ParagraphStyles.insertByName("NewStyle", NewStyle)
ParagraphStyles.replaceByName("ChangingStyle", NewStyle)
ParagraphStyles.removeByName("OldStyle")
</source>

The <tt>insertByName</tt> line inserts the <tt>NewStyle</tt> style under the name of the same name in the <tt>ParagraphStyles</tt> object. The <tt>replaceByName</tt> line changes the object behind <tt>ChangingStyle</tt> into <tt>NewStyle</tt>. Finally, the <tt>removeByName</tt> call removes the object behind <tt>OldStyle</tt> from <tt>ParagraphStyles</tt>.

== Index-Based Access to Subordinate Objects ==

The <tt>XIndexAccess</tt> and <tt>XIndexContainer</tt> interfaces are used in objects which contain subordinate objects and which can be addressed using an index.

<tt>XIndexAccess</tt> provides the methods for accessing individual objects. <tt>XIndexContainer</tt> provides methods for inserting and removing elements.

=== <tt>com.sun.star.container.XIndexAccess</tt> Interface ===

<tt>XIndexAccess</tt> provides the <tt>getByIndex</tt> and <tt>getCount</tt> methods for calling the subordinate objects. <tt>getByIndex</tt> provides an object with a particular index. <tt>getCount</tt> returns how many objects are available.

<source lang="oobas">
Dim Sheets As Object
Dim Sheet As Object
Dim I As Integer

Sheets = Spreadsheet.Sheets

For I = 0 to Sheets.getCount() - 1
Sheet = Sheets.getByIndex(I)
' Editing sheet
Next I
</source>

The example shows a loop that runs through all sheet elements one after another and saves a reference to each in the <tt>Sheet</tt> object variable. When working with the indexes, note that <tt>getCount</tt> returns the number of elements. The elements in <tt>getByIndex</tt> however are numbered beginning with 0. The counting variable of the loop therefore runs from 0 to <tt>getCount()-1</tt>.

=== <tt>com.sun.star.container.XIndexContainer</tt> Interface ===

The <tt>XIndexContainer</tt> interface provides the <tt>insertByIndex</tt> and <tt>removeByIndex</tt> functions. The parameters are structured in the same way as the corresponding functions in <tt>XNameContainer</tt>.

== Iterative Access to Subordinate Objects ==

In some instances, an object may contain a list of subordinate objects that cannot be addressed by either a name or an index. In these situations, the <tt>XEnumeration</tt> and <tt>XenumerationAccess</tt> interfaces are appropriate. They provide a mechanism through which all subordinate elements of an objects can be passed, step by step, without having to use direct addressing.

=== <tt>com.sun.star.container.XEnumeration</tt> and <tt>XenumerationAccess</tt> Interfaces ===

The basic object must provide the <tt>XEnumerationAccess</tt> interface, which contains only a <tt>createEnumeration</tt> method. This returns an auxiliary object, which in turn provides the <tt>XEnumeration</tt> interface with the <tt>hasMoreElements</tt> and <tt>nextElement</tt> methods. Through these, you then have access to the subordinate objects.

The following example steps through all the paragraphs of a text:

<source lang="oobas">
Dim ParagraphEnumeration As Object
Dim Paragraph As Object

ParagraphEnumeration = Textdoc.Text.createEnumeration

While ParagraphEnumeration.hasMoreElements()
Paragraph = ParagraphEnumeration.nextElement()
Wend
</source>

The example first creates a <tt>ParagraphEnumeration</tt> auxiliary object. This gradually returns the individual paragraphs of the text in a loop. The loop is terminated as soon as the <tt>hasMoreElements</tt> method returns the <tt>False</tt> value, signaling that the end of the text has been reached.

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide/Interface Overview}}

{{PDL1}}[[Category:G11n Wiki Translation Testing]]

G11ntest/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Boolean

2009-09-08T19:22:44Z

G11nAutomation:

{{DISPLAYTITLE:Boolean Variables}}

{{g11ntest/Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Numbers
|NextPage=Documentation/BASIC Guide/Date
|lang=block
}}

Boolean variables can only contain one of two values: <tt>True</tt> or <tt>False</tt>. They are suitable for binary specifications that can only adopt one of two statuses. A Boolean value is saved internally as a two-byte integer value, where 0 corresponds to the False and any other value to True. There is no type declaration symbol for Boolean variables. The declaration can only be made using the supplement <tt>As Boolean</tt>.

Example declaration of a Boolean variable:

<source lang="oobas">
Dim Variable As Boolean
</source>

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide/Boolean}}

{{PDL1}}[[Category:G11n Wiki Translation Testing]]

G11ntest/Documentation/BASIC Guide

2009-09-08T19:21:59Z

G11nAutomation:

{{g11ntest/Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=none
|NextPage=Documentation/BASIC Guide/Language
}}
{{DISPLAYTITLE:{{OOo}} Basic编程指南}}
____
{{Download_Collection|MediaWiki:Collections/BASIC_Guide}}

本指南将介绍Programming with {{OOo}} Basic。要获得充分利用本书,您应该熟悉其他编程语言。提供了大量示例,帮助您快速开发自己的 {{OOo}} Basic程序。

本指南将关于 {{OOo}} 管理几个章节。前三章介绍 {{OOo}} 基本:

* [[Documentation/BASIC Guide/Language|The Language of {{OOo}} Basic]]
* [[Documentation/BASIC Guide/Runtime_Library|Runtime Library]]
* [[g11ntest/Documentation/BASIC Guide/API_Intro|Introduction to the API]]

这些章节概述了 {{OOo}} 基本及应该阅读这些任何有意编写 {{OOo}} Basic程序。其余的章节介绍了各个组件 {{OOo}} API的详细信息,可以有选择地理解为必需的:

* [[Documentation/BASIC Guide/Documents|Working with Documents]]
* [[Documentation/BASIC Guide/Text Documents|Text Documents]]
* [[Documentation/BASIC Guide/Spreadsheets|Spreadsheet Documents]]
* [[Documentation/BASIC Guide/Drawings Presentations|Drawings and Presentations]]
* [[Documentation/BASIC Guide/Charts|Charts (Diagrams)]]
* [[Documentation/BASIC Guide/Database|Databases]]
* [[Documentation/BASIC Guide/Dialogs|Dialogs]]
* [[Documentation/BASIC Guide/Forms|Forms]]

== {{OOo}}

在 {{OOo}} Basic编程语言开发特别是, {{OOo}} 并且被紧密地集成到Office软件包。

顾名思义, {{OOo}} Basic编程语言Basic系列。以前使用过其他Basic语言〉(尤其是Visual Basic或Visual Basic for Applications(VBA)的Microsoft-将很快就能熟悉 {{OOo}} 基本。较大的基本结构 {{OOo}} Basic与Visual Basic兼容。

在 {{OOo}} Basic编程语言分为四个部分:

* 该语言 {{OOo}} Basic:定义基本语言结构,例如,变量声明、循环和函数。
* 运行时库:提供标准函数不直接引用 {{OOo}},例如,函数用于编辑数字、字串、日期值和文件。
* 此 {{OOo}} API(应用程序编程接口):允许访问 {{OOo}} 文档,并允许将这些创建、保存、修改和打印。
* 对话框编辑器:创建个人对话窗口并提供范围加入控制元素和事件处理程序。

{{Documentation/Note|Compatibility between {{OOo}} Basic和VBA与 {{OOo}} Basic语言和运行时库。此 {{OOo}} API和对话框编辑器不兼容的VBA(标准化这些接口会有很多的概念提供 {{OOo}} 无法实现)。 }}

用户 {{OOo}}

使用的范围, {{OOo}} Basic开始标准功能的 {{OOo}} 结束例程任务可自动在 {{OOo}} Basic中,链接可以建立与其他程序,例如数据库服务器,复杂活动可执行的按钮使用预设脚本。

{{OOo}} Basic可以完全访问所有 {{OOo}} 功能,支持所有功能,还可以修改文档类型,以及提供选项建立个人对话窗口。

== {{OOo}}

{{OOo}} 基本可由所有 {{OOo}} 用户,而没有任何附加程序和辅助工具。即使在标准安装中, {{OOo}} Basic具有所有组件所需创建自己的Basic宏,其中包括:

* 集成开发环境(IDE),它提供了编辑器用于创建和测试宏。
* 解释程序,时需要该运行 {{OOo}} Basic宏。
* 接口各种 {{OOo}} 应用程序,允许直接访问Office文档。

组件的 {{OOo}} API将介绍本指南中选择根据其实际价值的 {{OOo}} Basic程序员。一般只部分接口进行了讨论。有关详细图像,请参见 [http://api.openoffice.org/docs/common/ref/com/sun/star/module-ix.html the API reference]。

在 [[文档//OpenOffice.org_开发者_指南|Developer's Guide]]介绍了 {{OOo}} API更详细的情况指南》,而是主要适用于Java和C++ 程序员。任何已经熟悉了 {{OOo}} Basic编程可以查找其他信息Developer's Guide的 {{OOo}} 基本功能和 {{OOo}} 编程。

程序员希望直接在Java或C++ (而不是 {{OOo}} 基本应查阅《 {{OOo}} 开发者指南》,而此指南。 {{OOo}} 编程Java或C++ 是一个相当较复杂的进程编程 {{OOo}} Basic。

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide}}

{{PDL1}}[[Category:G11n Wiki Translation Testing]]

Template:G11NWIKITEST/Documentation/BASICGuideTOC/v2

2009-09-08T18:29:57Z

G11nAutomation:

{{Documentation/MasterTOC
|ShowPrevPage={{{ShowPrevPage}}}
|PrevPage={{{PrevPage}}}
|ShowNextPage={{{ShowNextPage}}}
|NextPage={{{NextPage}}}
|bookid=BASICGuide
|ShowParttitle=none
|ShowPrevPart=none
|ShowNextPart=none
|booktitle=[[G11NWIKITEST/Documentation/BASIC Guide|基本指南]]
|toccontent=<section begin=toccontent />
* [[G11NWIKITEST/Documentation/BASIC Guide/Language|多语言{{OOo}} Basic]]
<div id="lang" style="display:{{{lang|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Program Overview|基本程序概述]]
* [[Documentation/BASIC Guide/Working With Variables|利用变量工作]]
* [[Documentation/BASIC Guide/Strings|Strings]]
* [[Documentation/BASIC Guide/Numbers|Numbers]]
* [[Documentation/BASIC Guide/Boolean|Boolean Values]]
* [[Documentation/BASIC Guide/Date|Date and Time]]
* [[Documentation/BASIC Guide/Arrays|Arrays]]
* [[Documentation/BASIC Guide/Scope of Variables|Scope and Life Span of Variables]]
* [[Documentation/BASIC Guide/Constants|Constants]]
* [[Documentation/BASIC Guide/Operators|Operators]]
* [[Documentation/BASIC Guide/Branching|Branching]]
* [[Documentation/BASIC Guide/Loops|Loops]]
* [[Documentation/BASIC Guide/Procedures and Functions|Procedures and Functions]]
* [[Documentation/BASIC Guide/Error Handling|Error Handling]]
* [[Documentation/BASIC Guide/Other Instructions|Other Instructions]]
</div>
* [[Documentation/BASIC Guide/Runtime Library|Runtime Library中文]]
<div id="runtime" style="display:{{{runtime|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Conversion Functions (Runtime Library)|Conversion Functions]]
* [[Documentation/BASIC Guide/Strings (Runtime Library)|Strings]]
* [[Documentation/BASIC Guide/Date and Time (Runtime Library)|Date and Time]]
* [[Documentation/BASIC Guide/Files and Directories (Runtime Library)|Files and Directories]]
* [[Documentation/BASIC Guide/Message and Input Boxes (Runtime Library)|Message and Input Boxes]]
* [[Documentation/BASIC Guide/Other Functions (Runtime Library)|Other Functions]]
</div>
* [[Documentation/BASIC Guide/API Intro|介绍 API]]
<div id="api" style="display:{{{api|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/UNO|Universal Network Objects (UNO)]]
* [[Documentation/BASIC Guide/Properties and Methods (API)|Properties and Methods]]
* [[Documentation/BASIC Guide/Modules, Services and Interfaces|Modules, Services and Interfaces]]
* [[Documentation/BASIC Guide/UNO Tools|Tools for Working with UNO]]
* [[Documentation/BASIC Guide/Interface Overview|Overview of Central Interfaces]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Documents|参照文档工作]]
<div id="docs" style="display:{{{docs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/StarDesktop|The StarDesktop]]
* [[Documentation/BASIC Guide/Templates|模版]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Text Documents|文本文档]]
<div id="textdocs" style="display:{{{textdocs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Text Documents|The Structure of Text Documents]]
* [[Documentation/BASIC Guide/Editing Text Documents|Editing Text Documents]]
* [[Documentation/BASIC Guide/More Than Text|More than Just Text]]
</div>
* [[Documentation/BASIC Guide/Spreadsheets|数据表文档]]
<div id="spread" style="display:{{{spread|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Spreadsheets|The Structure of Spreadsheets]]
** [[Documentation/BASIC Guide/Rows and Columns|Rows and Columns]]
** [[Documentation/BASIC Guide/Cells and Ranges|Cells and Ranges]]
** [[Documentation/BASIC Guide/Formatting Spreadsheet Documents|Formatting Spreadsheet Documents]]
* [[Documentation/BASIC Guide/Editing Spreadsheet Documents|Editing Spreadsheet Documents]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Drawings Presentations|绘图和演示]]
<div id="draw" style="display:{{{draw|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Drawings|The Structure of Drawings]]
* [[Documentation/BASIC Guide/Editing Drawing Objects|Editing Drawing Objects]]
* [[Documentation/BASIC Guide/Presentations|Presentations]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Charts|Charts (Diagrams)]]
<div id="chart" style="display:{{{chart|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Charts in Spreadsheets|Using Charts in Spreadsheets]]
* [[Documentation/BASIC Guide/Structure of Charts|The Structure of Charts]]
* [[Documentation/BASIC Guide/Chart Types|图标类型]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Database|数据库]]
<div id="base" style="display:{{{base|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/SQL|SQL: a Query Language]]
* [[Documentation/BASIC Guide/Database Access Types|Types of Database Access]]
* [[Documentation/BASIC Guide/Data Sources|数据资源]]
* [[Documentation/BASIC Guide/Database Access|Database Access]]
</div>
* [[Documentation/BASIC Guide/Dialogs|Dialogs]]
<div id="dial" style="display:{{{dial|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Dialogs|Working With Dialogs]]
* [[Documentation/BASIC Guide/Properties|Properties]]
* [[Documentation/BASIC Guide/Events|Events]]
* [[Documentation/BASIC Guide/Control Elements|Dialog Control Elements]]
</div>
* [[G11NWIKITEST/Documentation/BASIC Guide/Forms|Forms]]
<div id="form" style="display:{{{form|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Forms|Working With Forms]]
* [[Documentation/BASIC Guide/Control Element Forms|Control Element Forms]]
* [[Documentation/BASIC Guide/Database Forms|Database Forms]]
</div>
<section end=toccontent />}}

[[Category:Documentation/BASIC Guide]]

<noinclude>
[[Category:Exclude in print|{{PAGENAME}}]]

</noinclude>[[Category:G11n Wiki Translation Testing]]

G11NWIKITEST/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Structure of Charts

2009-09-08T08:25:09Z

G11nAutomation:

{{G11NWIKITEST/Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Charts in Spreadsheets
|NextPage=Documentation/BASIC Guide/Chart Types
|chart=block
}}
{{DISPLAYTITLE:The Structure of Charts}}

__NOTOC__
The structure of a chart, and therefore the list of services and interfaces supported by it, depends on the chart type. For example, the methods and properties of the Z-axis, are available in 3D charts, but not in 2D charts, and in pie charts, there are no interfaces for working with axes.

== Title, Subtitle and Legend ==

Title, subtitle and legend are basic elements provided for every chart. The <tt>Chart</tt> object provides the following properties for administrating these elements:

;<tt>HasMainTitle (Boolean)</tt>:activates the title
;<tt>Title (Object)</tt>:object with detailed information about the chart title (supports the <idl>com.sun.star.chart.ChartTitle</idl> service)
;<tt>HasSubTitle(Boolean)</tt>:activates the subtitle
;<tt>Subtitle (Object)</tt>:object with detailed information about the chart subtitle (supports the <idl>com.sun.star.chart.ChartTitle</idl> service)
;<tt>HasLegend (Boolean)</tt>:activates the legend
;<tt>Legend (Object)</tt>:object with detailed information about the legend (supports the <idl>com.sun.star.chart.ChartLegend</idl> service)

Both services <tt>com.sun.star.chart.ChartTitle</tt> and <tt>com.sun.star.chart.ChartLegend</tt> do support the service <tt>com.sun.star.drawing.Shape</tt>. This allows to determine the position and size of the elements using the <tt>Position</tt> and <tt>Size</tt> properties. As the size of the legend and the titles is calculated automatically based on the current content and the character height for example, the size property provides read access only.

Fill and line properties (<idl>com.sun.star.drawing.FillProperties</idl> and <idl>com.sun.star.drawing.LineProperties</idl> services) as well as the character properties (<idl>com.sun.star.style.CharacterProperties</idl> service) are provided for further formatting of the elements.

<idl>com.sun.star.chart.ChartTitle</idl> contains not only the listed formatting properties, but also two other properties:

;<tt>String (String)</tt>:text which to be displayed as the title or subtitle
;<tt>TextRotation (Long)</tt>:angle of rotation of text in 100ths of a degree

The legend (<idl>com.sun.star.chart.ChartLegend</idl>) contains the following additional property:

;<tt>Alignment (Enum)</tt>:position at which the legend appears (value of type <idl>com.sun.star.chart.ChartLegendPosition</idl>)

The following example creates a chart with a title "Main Title String", a subtitle "Subtitle String" and a legend. The legend has a gray background color, is placed at the bottom of the chart, and has a character size of 7 points.

<source lang="oobas">
Dim Doc As Object
Dim Charts As Object
Dim Chart as Object
Dim Rect As New com.sun.star.awt.Rectangle
Dim RangeAddress(0) As New com.sun.star.table.CellRangeAddress

Rect.X = 8000
Rect.Y = 1000
Rect.Width = 10000
Rect.Height = 7000
RangeAddress(0).Sheet = 0
RangeAddress(0).StartColumn = 0
RangeAddress(0).StartRow = 0
RangeAddress(0).EndColumn = 2
RangeAddress(0).EndRow = 12

Doc = StarDesktop.CurrentComponent

Charts = Doc.Sheets(0).Charts
Charts.addNewByName("MyChart", Rect, RangeAddress(), True, True)
Chart = Charts.getByName("MyChart").EmbeddedObject
Chart.HasMainTitle = True
Chart.Title.String = "Main Title String"
Chart.HasSubTitle = True
Chart.Subtitle.String = "Subtitle String"
Chart.HasLegend = True
Chart.Legend.Alignment = com.sun.star.chart.ChartLegendPosition.BOTTOM
Chart.Legend.FillStyle = com.sun.star.drawing.FillStyle.SOLID
Chart.Legend.FillColor = RGB(210, 210, 210)
Chart.Legend.CharHeight = 7
</source>

== Background ==

Every chart has a background area. The <tt>Chart</tt> object provides the property <tt>Area</tt> to format the background:

;<tt>Area (Object)</tt>:background area of the chart (supports <idl>com.sun.star.chart.ChartArea</idl> service)

The background of a chart covers its complete area, including the area under the title, subtitle and legend. The associated <idl>com.sun.star.chart.ChartArea</idl> service supports line and fill properties.

== Diagram ==

The <tt>Chart</tt> object provides the property <tt>Diagram</tt> which forms the coordinate system with axes and grids, where the data finally is displayed:

;<tt>Diagram (Object)</tt>:object forming the coordinate system where the data is plotted. It supports <idl>com.sun.star.chart.Diagram</idl> service and:
:* <idl>com.sun.star.chart.StackableDiagram</idl>
:* <idl>com.sun.star.chart.ChartAxisXSupplier</idl>
:* <idl>com.sun.star.chart.ChartAxisYSupplier</idl>
:* <idl>com.sun.star.chart.ChartAxisZSupplier</idl>
:* <idl>com.sun.star.chart.ChartTwoAxisXSupplier</idl>
:* <idl>com.sun.star.chart.ChartTwoAxisYSupplier</idl>

Different services are supported depending on the chart type (see
[[Documentation/BASIC_Guide/Chart_Types|Chart Types]]).

== Wall and Floor ==

The chart wall is the background of the coordinate system where the data is plotted.
Two chart walls usually exist for 3D charts: one behind the plotted data and one as the left-hand or right-hand demarcation. This depends on the rotation of the chart. 3D charts usually also have a floor.

The <tt>Diagram</tt> object provides the properties Wall and Floor:

;<tt>Wall (Object)</tt>:background wall of the coordinate system (supports <idl>com.sun.star.chart.ChartArea</idl> service)
;<tt>Floor (Object)</tt>:floor panel of coordinate system (only for 3D charts, supports <idl>com.sun.star.chart.ChartArea</idl> service)

The specified objects support the <tt>com.sun.star.chart.ChartArea</tt> service, which provides the usual fill and line properties (<idl>com.sun.star.drawing.FillProperties</idl> and <idl>com.sun.star.drawing.LineProperties</idl> services, refer to [[G11NWIKITEST/Documentation/BASIC_Guide/Drawings_Presentations|Drawings and Presentations]]).

The following example shows how graphics (named Sky) already contained in {{OOo}} can be used as a background for a chart. The wall is set to be blue.

<source lang="oobas">
Dim Doc As Object
Dim Charts As Object
Dim Chart as Object
Dim Rect As New com.sun.star.awt.Rectangle
Dim RangeAddress(0) As New com.sun.star.table.CellRangeAddress

Rect.X = 8000
Rect.Y = 1000
Rect.Width = 10000
Rect.Height = 7000
RangeAddress(0).Sheet = 0
RangeAddress(0).StartColumn = 0
RangeAddress(0).StartRow = 0
RangeAddress(0).EndColumn = 2
RangeAddress(0).EndRow = 12

Doc = StarDesktop.CurrentComponent

Charts = Doc.Sheets(0).Charts
Charts.addNewByName("MyChart", Rect, RangeAddress(), True, True)
Chart = Charts.getByName("MyChart").EmbeddedObject
Chart.Area.FillStyle = com.sun.star.drawing.FillStyle.BITMAP
Chart.Area.FillBitmapName = "Sky"
Chart.Area.FillBitmapMode = com.sun.star.drawing.BitmapMode.REPEAT

Chart.Diagram.Wall.FillStyle = com.sun.star.drawing.FillStyle.SOLID
Chart.Diagram.Wall.FillColor = RGB(00,132,209)
</source>

== Axes ==

{{OOo}} recognizes five different axes that can be used in a chart. In the simplest scenario, these are the X and Y-axes. When working with 3D charts, a Z-axis is also sometimes provided. For charts in which the values of the various rows of data deviate significantly from one another, {{OOo}} provides a second X and Y-axis for second scaling operations.

The <tt>Diagram</tt> object provides the following properties to access the axes:

;<tt>HasXAxis (Boolean)</tt>:activates the X-axis
;<tt>XAxis (Object)</tt>:object with detailed information about the X-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasXAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the X-axis

;<tt>HasYAxis (Boolean)</tt>:activates the Y-axis
;<tt>YAxis (Object)</tt>:object with detailed information about the Y-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasYAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the Y-axis

;<tt>HasZAxis (Boolean)</tt>:activates the Z-axis
;<tt>ZAxis (Object)</tt>:object with detailed information about the Z-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasZAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the Z-axis

;<tt>HasSecondaryXAxis (Boolean)</tt>:activates the secondary X-axis
;<tt>SecondaryXAxis (Object)</tt>:object with detailed information about the secondary X-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasSecondaryXAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the secondary X-axis

;<tt>HasSecondaryYAxis (Boolean)</tt>:activates the secondary Y-axis
;<tt>SecondaryYAxis (Object)</tt>:object with detailed information about the secondary Y-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasSecondaryYAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the secondary Y-axis

== Properties of Axes ==

The axis objects of a {{OOo}} chart support the <idl>com.sun.star.chart.ChartAxis</idl> service. In addition to the properties for characters <idl>(com.sun.star.style.CharacterProperties</idl> service, refer to [[G11NWIKITEST/Documentation/BASIC_Guide/Text_Documents|Text Documents]]) and lines <idl>(com.sun.star.drawing.LineStyle</idl> service, refer to [[G11NWIKITEST/Documentation/BASIC_Guide/Drawings_Presentations|Drawings and Presentations]]), it provides the following properties:

===Scaling properties:===
;<tt>Max (Double)</tt>:maximum value for axis
;<tt>Min (Double)</tt>:minimum value for axis
;<tt>Origin (Double)</tt>:point of intersect for crossing axes
;<tt>StepMain (Double)</tt>:distance between the major interval marks
;<tt>StepHelp (Double)</tt>:distance between the minor interval marks (deprecated since OpenOffice.org 3.0; Use property StepHelpCount instead)
;<tt>StepHelpCount (Long)</tt>:Contains the number of minor intervals within a major interval. E.g. a StepHelpCount of 5 divides the major interval into 5 pieces and thus produces 4 minor tick marks. (available since OpenOffice.org 3.0)
;<tt>AutoMax (Boolean)</tt>:the maximum value for the axis is calculated automatically when set to true
;<tt>AutoMin (Boolean)</tt>:the minimum value for the axis is calculated automatically when set to true
;<tt>AutoOrigin (Boolean)</tt>:the origin is determined automatically when set to true
;<tt>AutoStepMain (Boolean)</tt>:StepMain is determined automatically when set to true
;<tt>AutoStepHelp (Boolean)</tt>:StepHelpCount is determined automatically when set to true
;<tt>Logarithmic (Boolean)</tt>:scales the axes in logarithmic manner (rather than linear)
;<tt>ReverseDirection (Boolean)</tt>:determines if the axis orientation is mathematical or reversed. (available since OpenOffice.org 2.4)

===Label properties:===
;<tt>DisplayLabels (Boolean)</tt>:activates the text label at the interval marks
;<tt>TextRotation (Long)</tt>:angle of rotation of text label in 100ths of a degree
;<tt>ArrangeOrder (enum)</tt>:the label may be staggered, thus they are positioned alternately over two lines (values according to <idl>com.sun.star.chart.ChartAxisArrangeOrderType</idl>)
;<tt>TextBreak (Boolean)</tt>:permits line breaks within the axes labels
;<tt>TextCanOverlap (Boolean)</tt>:permits an overlap of the axes labels
;<tt>NumberFormat (Long)</tt>:number format to be used with the axes labels
;<tt>LinkNumberFormatToSource (Boolean)</tt>:determines whether to use the number format given by the container document, or from the property <tt>NumberFormat</tt>. (since OpenOffice.org 2.3)

===Interval mark properties:===
;<tt>Marks (Const)</tt>:determines the position of the major interval marks (values in accordance with <idl>com.sun.star.chart.ChartAxisMarks</idl>)
;<tt>HelpMarks (Const)</tt>:determines the position of the minor interval marks (values in accordance with <idl>com.sun.star.chart.ChartAxisMarks</idl>)

===Only for bar charts:===
;<tt>Overlap (Long)</tt>:percentage which specifies the extent to which the bars of different sets of data may overlap (at 100%, the bars are shown as completely overlapping, at -100%, there is a distance of the width of one bar between them)
;<tt>GapWidth (long)</tt>:percentage which specifies the distance there may be between the different groups of bars of a chart (at 100%, there is a distance corresponding to the width of one bar)

== Grids ==

For the primary axes grids and sub grids can be displayed, matching to the major and minor intervals.
The <tt>Diagram</tt> object provides the following properties to access the grids:

;<tt>HasXAxisGrid (Boolean)</tt>:activates major grid for X-axis
;<tt>XMainGrid (Object)</tt>:object with detailed information about the major grid for X-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)
;<tt>HasXAxisHelpGrid (Boolean)</tt>:activates minor grid for X-axis
;<tt>XHelpGrid (Object)</tt>:object with detailed information about the minor grid for X-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)

the same for y and z:

;<tt>HasYAxisGrid (Boolean)</tt>:activates major grid for Y-axis
;<tt>YMainGrid (Object)</tt>:object with detailed information about the major grid for Y-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)
;<tt>HasYAxisHelpGrid (Boolean)</tt>:activates minor grid for Y-axis
;<tt>YHelpGrid (Object)</tt>:object with detailed information about the minor grid for Y-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)

;<tt>HasZAxisGrid (Boolean)</tt>:activates major grid for Z-axis
;<tt>ZMainGrid (Object)</tt>:object with detailed information about the major grid for Z-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)
;<tt>HasZAxisHelpGrid (Boolean)</tt>:activates minor grid for Z-axis
;<tt>ZHelpGrid (Object)</tt>:object with detailed information about the minor grid for Z-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)

The grid object is based on the <idl>com.sun.star.chart.ChartGrid</idl> service, which in turn supports the line properties of the <idl>com.sun.star.drawing.LineStyle</idl> support service (refer to [[G11NWIKITEST/Documentation/BASIC_Guide/Drawings_Presentations|Drawings and Presentations]]).

== Axes Title ==

For all axes an additional title can be displayed.
The <tt>Diagram</tt> object provides the following properties to access the axes title:

;<tt>HasXAxisTitle (Boolean)</tt>:activates title of X-axis
;<tt>XAxisTitle (Object)</tt>:object with detailed information about title of the X-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

same y and z:

;<tt>HasYAxisTitle (Boolean)</tt>:activates title of Y-axis
;<tt>YAxisTitle (Object)</tt>:object with detailed information about title of the Y-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

;<tt>HasZAxisTitle (Boolean)</tt>:activates title of Z-axis
;<tt>ZAxisTitle (Object)</tt>:object with detailed information about title of the Z-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

and for the secondary axes (available since OpenOffice.org 3.0):

;<tt>HasSecondaryXAxisTitle (Boolean)</tt>:activates title of the secondary X-axis.
;<tt>SecondXAxisTitle (Object)</tt>:object with detailed information about title of the secondary X-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

;<tt>HasSecondaryYAxisTitle (Boolean)</tt>:activates title of the secondary Y-axis.
;<tt>SecondYAxisTitle (Object)</tt>:object with detailed information about title of the secondary Y-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

The objects for formatting the axes title are based on the <idl>com.sun.star.chart.ChartTitle</idl> service, which is also used for chart titles.

=== Example ===

The following example creates a line chart. The color for the rear wall of the chart is set to white. Both the X and Y-axes have a gray grid for visual orientation. The minimum value of the Y-axis is fixed to 0 and the maximum value is fixed to 100 so that the resolution of the chart is retained even if the values are changed. The X-axis points in reverse direction from right to left. And a title for the X-axis was added.

<source lang="oobas">
Dim Doc As Object
Dim Charts As Object
Dim Chart as Object
Dim Rect As New com.sun.star.awt.Rectangle
Dim RangeAddress(0) As New com.sun.star.table.CellRangeAddress

Doc = StarDesktop.CurrentComponent
Charts = Doc.Sheets(0).Charts

Rect.X = 8000
Rect.Y = 1000
Rect.Width = 10000
Rect.Height = 7000
RangeAddress(0).Sheet = 0
RangeAddress(0).StartColumn = 0
RangeAddress(0).StartRow = 0
RangeAddress(0).EndColumn = 2
RangeAddress(0).EndRow = 12

Charts.addNewByName("MyChart", Rect, RangeAddress(), True, True)
Chart = Charts.getByName("MyChart").embeddedObject
Chart.Diagram = Chart.createInstance("com.sun.star.chart.LineDiagram")
Chart.Diagram.Wall.FillColor = RGB(255, 255, 255)
Chart.Diagram.HasXAxisGrid = True
Chart.Diagram.XMainGrid.LineColor = RGB(192, 192, 192)
Chart.Diagram.HasYAxisGrid = True
Chart.Diagram.YMainGrid.LineColor = RGB(192, 192, 192)
Chart.Diagram.YAxis.Min = 0
Chart.Diagram.YAxis.Max = 100

Chart.Diagram.XAxis.ReverseDirection = true 'needs OpenOffice.org 2.4 or newer
Chart.Diagram.HasXAxisTitle = true
Chart.Diagram.XAxisTitle.String = "Reversed X Axis Example"
</source>

== 3D Charts ==

Most charts in {{OOo}} can also be displayed with 3D graphics. The following properties are provided for 3D charts at the <tt>Diagram</tt> object:

;<tt>Dim3D (Boolean)</tt>:activates 3D display
;<tt>Deep (Boolean)</tt>:the series will be arranged behind each other in z-direction
;<tt>RightAngledAxes (Boolean)</tt>:activates a 3D display mode where X- and Y-axes form a right angle within the projection. (available since OpenOffice.org 2.3)
;<tt>D3DScenePerspective (Enum)</tt>:defines whether the 3D objects are to be drawn in perspective or parallel projection.(values according to <idl>com.sun.star.drawing.ProjectionMode</idl>)
;<tt>Perspective (Long)</tt>:Perspective of 3D charts ( [0,100] ) (available since OpenOffice.org 2.4.1)
;<tt>RotationHorizontal (Long)</tt>:Horizontal rotation of 3D charts in degrees ( [-180,180] ) (available since OpenOffice.org 2.4.1)
;<tt>RotationVertical (Long)</tt>:Vertical rotation of 3D charts in degrees ( [-180,180] ) (available since OpenOffice.org 2.4.1)

The following example creates a 3D area chart.

<source lang="oobas">
Dim Doc As Object
Dim Charts As Object
Dim Chart as Object
Dim Rect As New com.sun.star.awt.Rectangle
Dim RangeAddress(0) As New com.sun.star.table.CellRangeAddress

Doc = StarDesktop.CurrentComponent
Charts = Doc.Sheets(0).Charts

Rect.X = 8000
Rect.Y = 1000
Rect.Width = 10000
Rect.Height = 7000
RangeAddress(0).Sheet = 0
RangeAddress(0).StartColumn = 0
RangeAddress(0).StartRow = 0
RangeAddress(0).EndColumn = 2
RangeAddress(0).EndRow = 12

Charts.addNewByName("MyChart", Rect, RangeAddress(), True, True)
Chart = Charts.getByName("MyChart").embeddedObject
Chart.Diagram = Chart.createInstance("com.sun.star.chart.AreaDiagram")
Chart.Diagram.Dim3D = true
Chart.Diagram.Deep = true
Chart.Diagram.RightAngledAxes = true 'needs OpenOffice.org 2.3 or newer
Chart.Diagram.D3DScenePerspective = com.sun.star.drawing.ProjectionMode.PERSPECTIVE
Chart.Diagram.Perspective = 100 'needs OpenOffice.org 2.4.1 or newer
Chart.Diagram.RotationHorizontal = 60 'needs OpenOffice.org 2.4.1 or newer
Chart.Diagram.RotationVertical = 30 'needs OpenOffice.org 2.4.1 or newer
</source>

== Stacked Charts ==

Stacked charts are charts that are arranged with several individual values on top of one another to produce a total value. This view shows not only the individual values, but also an overview of all the values.

In {{OOo}}, various types of charts can be displayed in a stacked form. All of these charts support the <idl>com.sun.star.chart.StackableDiagram</idl> service, which in turn provides the following properties:

;<tt>Stacked (Boolean)</tt>:activates the stacked viewing mode
;<tt>Percent (Boolean)</tt>:rather than absolute values, displays their percentage distribution

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide/Structure of Charts}}

{{PDL1}}[[Category:G11n Wiki Translation Testing]]

G11NWIKITEST/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Interface Overview

2009-09-08T08:24:50Z

G11nAutomation:

{{G11NWIKITEST/Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/UNO Tools
|NextPage=Documentation/BASIC Guide/Documents
|api=block
}}
{{DISPLAYTITLE:Overview of Some Central Interfaces}}

__NOTOC__
Some interfaces of {{OOo}} can be found in many parts of the {{OOo}} API. They define sets of methods for abstract tasks which can be applied to various problems. Here, you will find an overview of the most common of these interfaces.

The origin of the objects is explained at a later point in this guide. At this point, only some of the abstract aspects of objects, for which the {{OOo}} API provides some central interfaces, are discussed.

== Creating Context-Dependent Objects ==

The {{OOo}} API provides two options for creating objects. One can be found in the <tt>createUnoService</tt> function mentioned at the start of this chapter. <tt>createUnoService</tt> creates an object which can be used universally. Such objects and services are also known as context-independent services.

In addition to context-independent services, there are also context-dependent services whose objects are only useful when used in conjunction with another object. A drawing object for a spreadsheet document, for example, can therefore only exist in conjunction with this one document.

=== <tt>com.sun.star.lang.XMultiServiceFactory</tt> Interface ===

Context-dependent objects are usually created by means of an object method, on which the object depends. The <tt>createInstance</tt> method, which is defined in the <tt>XMultiServiceFactory</tt> interface, is used in particular in the document objects.

The drawing object can, for example, be created as follows using a spreadsheet object:

<source lang="oobas">
Dim RectangleShape As Object
RectangleShape = _
Spreadsheet.createInstance("com.sun.star.drawing.RectangleShape")
</source>

A paragraph template in a text document is created in the same way:

<source lang="oobas">
Dim Style as Object
Style = Textdocument.createInstance("com.sun.star.style.ParagraphStyle")
</source>

== Named Access to Subordinate Objects ==

The <tt>XNameAccess</tt> and <tt>XNameContainer</tt> interfaces are used in objects that contain subordinate objects, which can be addressed using a natural language name.

While <tt>XNamedAccess</tt> permits access to the individual objects, <tt>XNameContainer</tt> takes on the insertion, modification and deletion of elements.

=== <tt>com.sun.star.container.XNameAccess</tt> Interface ===

An example of the use of <tt>XNameAccess</tt> is provided by the <tt>sheets</tt> object of a spreadsheet. It combines all the pages within the spreadsheet. The individual pages are accessed from the <tt>sheets</tt> object, by using the <tt>getByName</tt> method from <tt>XNameAccess</tt>:

<source lang="oobas">
Dim Sheets As Object
Dim Sheet As Object

Sheets = Spreadsheet.Sheets
Sheet = Sheets.getByName("Sheet1")
</source>

The <tt>getElementNames</tt> method provides an overview of the names of all elements. As a result, it returns a data field containing the names. The following example shows how all element names of a spreadsheet can thereby be determined and displayed in a loop:

<source lang="oobas">
Dim Sheets As Object
Dim SheetNames
Dim I As Integer

Sheets = Spreadsheet.Sheets
SheetNames = Sheets.getElementNames

For I=LBound(SheetNames) To UBound(SheetNames)
MsgBox SheetNames(I)
Next I
</source>

The <tt>hasByName</tt> method of the <tt>XNameAccess</tt> interface reveals whether a subordinate object with a particular name exists within the basic object. The following example therefore displays a message that informs the user whether the <tt>Spreadsheet</tt> object contains a page of the name <tt>Sheet1</tt>.

<source lang="oobas">
Dim Sheets As Object

Sheets = Spreadsheet.Sheets
If Sheets.HasByName("Sheet1") Then
MsgBox " Sheet1 available"
Else
MsgBox "Sheet1 not available"
End If
</source>

=== <tt>com.sun.star.container.XNameContainer</tt> Interface ===

The <tt>XNameContainer</tt> interface takes on the insertion, deletion and modification of subordinate elements in a basic object. The functions responsible are <tt>insertByName</tt>, <tt>removeByName</tt> and <tt>replaceByName</tt>.

The following is a practical example of this. It calls a text document, which contains a <tt>StyleFamilies</tt> object and uses this to in turn make the paragraph templates (ParagraphStyles) of the document available.

<source lang="oobas">
Dim StyleFamilies As Object
Dim ParagraphStyles As Object
Dim NewStyle As Object

StyleFamilies = Textdoc.StyleFamilies
ParagraphStyles = StyleFamilies.getByName("ParagraphStyles")
ParagraphStyles.insertByName("NewStyle", NewStyle)
ParagraphStyles.replaceByName("ChangingStyle", NewStyle)
ParagraphStyles.removeByName("OldStyle")
</source>

The <tt>insertByName</tt> line inserts the <tt>NewStyle</tt> style under the name of the same name in the <tt>ParagraphStyles</tt> object. The <tt>replaceByName</tt> line changes the object behind <tt>ChangingStyle</tt> into <tt>NewStyle</tt>. Finally, the <tt>removeByName</tt> call removes the object behind <tt>OldStyle</tt> from <tt>ParagraphStyles</tt>.

== Index-Based Access to Subordinate Objects ==

The <tt>XIndexAccess</tt> and <tt>XIndexContainer</tt> interfaces are used in objects which contain subordinate objects and which can be addressed using an index.

<tt>XIndexAccess</tt> provides the methods for accessing individual objects. <tt>XIndexContainer</tt> provides methods for inserting and removing elements.

=== <tt>com.sun.star.container.XIndexAccess</tt> Interface ===

<tt>XIndexAccess</tt> provides the <tt>getByIndex</tt> and <tt>getCount</tt> methods for calling the subordinate objects. <tt>getByIndex</tt> provides an object with a particular index. <tt>getCount</tt> returns how many objects are available.

<source lang="oobas">
Dim Sheets As Object
Dim Sheet As Object
Dim I As Integer

Sheets = Spreadsheet.Sheets

For I = 0 to Sheets.getCount() - 1
Sheet = Sheets.getByIndex(I)
' Editing sheet
Next I
</source>

The example shows a loop that runs through all sheet elements one after another and saves a reference to each in the <tt>Sheet</tt> object variable. When working with the indexes, note that <tt>getCount</tt> returns the number of elements. The elements in <tt>getByIndex</tt> however are numbered beginning with 0. The counting variable of the loop therefore runs from 0 to <tt>getCount()-1</tt>.

=== <tt>com.sun.star.container.XIndexContainer</tt> Interface ===

The <tt>XIndexContainer</tt> interface provides the <tt>insertByIndex</tt> and <tt>removeByIndex</tt> functions. The parameters are structured in the same way as the corresponding functions in <tt>XNameContainer</tt>.

== Iterative Access to Subordinate Objects ==

In some instances, an object may contain a list of subordinate objects that cannot be addressed by either a name or an index. In these situations, the <tt>XEnumeration</tt> and <tt>XenumerationAccess</tt> interfaces are appropriate. They provide a mechanism through which all subordinate elements of an objects can be passed, step by step, without having to use direct addressing.

=== <tt>com.sun.star.container.XEnumeration</tt> and <tt>XenumerationAccess</tt> Interfaces ===

The basic object must provide the <tt>XEnumerationAccess</tt> interface, which contains only a <tt>createEnumeration</tt> method. This returns an auxiliary object, which in turn provides the <tt>XEnumeration</tt> interface with the <tt>hasMoreElements</tt> and <tt>nextElement</tt> methods. Through these, you then have access to the subordinate objects.

The following example steps through all the paragraphs of a text:

<source lang="oobas">
Dim ParagraphEnumeration As Object
Dim Paragraph As Object

ParagraphEnumeration = Textdoc.Text.createEnumeration

While ParagraphEnumeration.hasMoreElements()
Paragraph = ParagraphEnumeration.nextElement()
Wend
</source>

The example first creates a <tt>ParagraphEnumeration</tt> auxiliary object. This gradually returns the individual paragraphs of the text in a loop. The loop is terminated as soon as the <tt>hasMoreElements</tt> method returns the <tt>False</tt> value, signaling that the end of the text has been reached.

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide/Interface Overview}}

{{PDL1}}[[Category:G11n Wiki Translation Testing]]

G11NWIKITEST/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Boolean

2009-09-08T08:24:37Z

G11nAutomation:

{{DISPLAYTITLE:Boolean Variables}}

{{G11NWIKITEST/Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Numbers
|NextPage=Documentation/BASIC Guide/Date
|lang=block
}}

Boolean variables can only contain one of two values: <tt>True</tt> or <tt>False</tt>. They are suitable for binary specifications that can only adopt one of two statuses. A Boolean value is saved internally as a two-byte integer value, where 0 corresponds to the False and any other value to True. There is no type declaration symbol for Boolean variables. The declaration can only be made using the supplement <tt>As Boolean</tt>.

Example declaration of a Boolean variable:

<source lang="oobas">
Dim Variable As Boolean
</source>

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide/Boolean}}

{{PDL1}}[[Category:G11n Wiki Translation Testing]]

Template:G11NWIKITEST/Documentation/BASICGuideTOC/v2

2009-09-08T08:22:00Z

G11nAutomation:

{{Documentation/MasterTOC
|ShowPrevPage={{{ShowPrevPage}}}
|PrevPage={{{PrevPage}}}
|ShowNextPage={{{ShowNextPage}}}
|NextPage={{{NextPage}}}
|bookid=BASICGuide
|ShowParttitle=none
|ShowPrevPart=none
|ShowNextPart=none
|booktitle=[[Documentation/BASIC Guide|基本指南]]
|toccontent=<section begin=toccontent />
* [[Documentation/BASIC Guide/Language|多语言{{OOo}} Basic]]
<div id="lang" style="display:{{{lang|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Program Overview|基本程序概述]]
* [[Documentation/BASIC Guide/Working With Variables|利用变量工作]]
* [[Documentation/BASIC Guide/Strings|Strings]]
* [[Documentation/BASIC Guide/Numbers|Numbers]]
* [[Documentation/BASIC Guide/Boolean|Boolean Values]]
* [[Documentation/BASIC Guide/Date|Date and Time]]
* [[Documentation/BASIC Guide/Arrays|Arrays]]
* [[Documentation/BASIC Guide/Scope of Variables|Scope and Life Span of Variables]]
* [[Documentation/BASIC Guide/Constants|Constants]]
* [[Documentation/BASIC Guide/Operators|Operators]]
* [[Documentation/BASIC Guide/Branching|Branching]]
* [[Documentation/BASIC Guide/Loops|Loops]]
* [[Documentation/BASIC Guide/Procedures and Functions|Procedures and Functions]]
* [[Documentation/BASIC Guide/Error Handling|Error Handling]]
* [[Documentation/BASIC Guide/Other Instructions|Other Instructions]]
</div>
* [[Documentation/BASIC Guide/Runtime Library|Runtime Library中文]]
<div id="runtime" style="display:{{{runtime|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Conversion Functions (Runtime Library)|Conversion Functions]]
* [[Documentation/BASIC Guide/Strings (Runtime Library)|Strings]]
* [[Documentation/BASIC Guide/Date and Time (Runtime Library)|Date and Time]]
* [[Documentation/BASIC Guide/Files and Directories (Runtime Library)|Files and Directories]]
* [[Documentation/BASIC Guide/Message and Input Boxes (Runtime Library)|Message and Input Boxes]]
* [[Documentation/BASIC Guide/Other Functions (Runtime Library)|Other Functions]]
</div>
* [[Documentation/BASIC Guide/API Intro|介绍 API]]
<div id="api" style="display:{{{api|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/UNO|Universal Network Objects (UNO)]]
* [[Documentation/BASIC Guide/Properties and Methods (API)|Properties and Methods]]
* [[Documentation/BASIC Guide/Modules, Services and Interfaces|Modules, Services and Interfaces]]
* [[Documentation/BASIC Guide/UNO Tools|Tools for Working with UNO]]
* [[Documentation/BASIC Guide/Interface Overview|Overview of Central Interfaces]]
</div>
* [[Documentation/BASIC Guide/Documents|参照文档工作]]
<div id="docs" style="display:{{{docs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/StarDesktop|The StarDesktop]]
* [[Documentation/BASIC Guide/Templates|模版]]
</div>
* [[Documentation/BASIC Guide/Text Documents|文本文档]]
<div id="textdocs" style="display:{{{textdocs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Text Documents|The Structure of Text Documents]]
* [[Documentation/BASIC Guide/Editing Text Documents|Editing Text Documents]]
* [[Documentation/BASIC Guide/More Than Text|More than Just Text]]
</div>
* [[Documentation/BASIC Guide/Spreadsheets|数据表文档]]
<div id="spread" style="display:{{{spread|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Spreadsheets|The Structure of Spreadsheets]]
** [[Documentation/BASIC Guide/Rows and Columns|Rows and Columns]]
** [[Documentation/BASIC Guide/Cells and Ranges|Cells and Ranges]]
** [[Documentation/BASIC Guide/Formatting Spreadsheet Documents|Formatting Spreadsheet Documents]]
* [[Documentation/BASIC Guide/Editing Spreadsheet Documents|Editing Spreadsheet Documents]]
</div>
* [[Documentation/BASIC Guide/Drawings Presentations|绘图和演示]]
<div id="draw" style="display:{{{draw|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Drawings|The Structure of Drawings]]
* [[Documentation/BASIC Guide/Editing Drawing Objects|Editing Drawing Objects]]
* [[Documentation/BASIC Guide/Presentations|Presentations]]
</div>
* [[Documentation/BASIC Guide/Charts|Charts (Diagrams)]]
<div id="chart" style="display:{{{chart|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Charts in Spreadsheets|Using Charts in Spreadsheets]]
* [[Documentation/BASIC Guide/Structure of Charts|The Structure of Charts]]
* [[Documentation/BASIC Guide/Chart Types|图标类型]]
</div>
* [[Documentation/BASIC Guide/Database|数据库]]
<div id="base" style="display:{{{base|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/SQL|SQL: a Query Language]]
* [[Documentation/BASIC Guide/Database Access Types|Types of Database Access]]
* [[Documentation/BASIC Guide/Data Sources|数据资源]]
* [[Documentation/BASIC Guide/Database Access|Database Access]]
</div>
* [[Documentation/BASIC Guide/Dialogs|Dialogs]]
<div id="dial" style="display:{{{dial|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Dialogs|Working With Dialogs]]
* [[Documentation/BASIC Guide/Properties|Properties]]
* [[Documentation/BASIC Guide/Events|Events]]
* [[Documentation/BASIC Guide/Control Elements|Dialog Control Elements]]
</div>
* [[Documentation/BASIC Guide/Forms|Forms]]
<div id="form" style="display:{{{form|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Forms|Working With Forms]]
* [[Documentation/BASIC Guide/Control Element Forms|Control Element Forms]]
* [[Documentation/BASIC Guide/Database Forms|Database Forms]]
</div>
<section end=toccontent />}}

[[Category:Documentation/BASIC Guide]]

<noinclude>
[[Category:Exclude in print|{{PAGENAME}}]]

</noinclude>[[Category:G11n Wiki Translation Testing]]

MediaWiki source Documentation BASIC/Template:g11ntest/Documentation/BASICGuideTOC/v2

2009-09-08T07:25:30Z

G11nAutomation: Created page with '{{Documentation/MasterTOC |ShowPrevPage={{{ShowPrevPage}}} |PrevPage={{{PrevPage}}} |ShowNextPage={{{ShowNextPage}}} |NextPage={{{NextPage}}} |bookid=BASICGuide |ShowParttitle=no…'

{{Documentation/MasterTOC
|ShowPrevPage={{{ShowPrevPage}}}
|PrevPage={{{PrevPage}}}
|ShowNextPage={{{ShowNextPage}}}
|NextPage={{{NextPage}}}
|bookid=BASICGuide
|ShowParttitle=none
|ShowPrevPart=none
|ShowNextPart=none
|booktitle=[[Documentation/BASIC Guide|BASIC Guide]]
|toccontent=<section begin=toccontent />
* [[Documentation/BASIC Guide/Language|语言{{OOo}} Basic]]
<div id="lang" style="display:{{{lang|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Program Overview|Overview of a Basic Program]]
* [[Documentation/BASIC Guide/Working With Variables|Working With Variables]]
* [[Documentation/BASIC Guide/Strings|Strings]]
* [[Documentation/BASIC Guide/Numbers|Numbers]]
* [[Documentation/BASIC Guide/Boolean|Boolean Values]]
* [[Documentation/BASIC Guide/Date|Date and Time]]
* [[Documentation/BASIC Guide/Arrays|Arrays]]
* [[Documentation/BASIC Guide/Scope of Variables|Scope and Life Span of Variables]]
* [[Documentation/BASIC Guide/Constants|Constants]]
* [[Documentation/BASIC Guide/Operators|Operators]]
* [[Documentation/BASIC Guide/Branching|Branching]]
* [[Documentation/BASIC Guide/Loops|Loops]]
* [[Documentation/BASIC Guide/Procedures and Functions|Procedures and Functions]]
* [[Documentation/BASIC Guide/Error Handling|Error Handling]]
* [[Documentation/BASIC Guide/Other Instructions|Other Instructions]]
</div>
* [[Documentation/BASIC Guide/Runtime Library|Runtime Library中文]]
<div id="runtime" style="display:{{{runtime|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Conversion Functions (Runtime Library)|Conversion Functions]]
* [[Documentation/BASIC Guide/Strings (Runtime Library)|Strings]]
* [[Documentation/BASIC Guide/Date and Time (Runtime Library)|Date and Time]]
* [[Documentation/BASIC Guide/Files and Directories (Runtime Library)|Files and Directories]]
* [[Documentation/BASIC Guide/Message and Input Boxes (Runtime Library)|Message and Input Boxes]]
* [[Documentation/BASIC Guide/Other Functions (Runtime Library)|Other Functions]]
</div>
* [[Documentation/BASIC Guide/API Intro|介绍 API]]
<div id="api" style="display:{{{api|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/UNO|Universal Network Objects (UNO)]]
* [[Documentation/BASIC Guide/Properties and Methods (API)|Properties and Methods]]
* [[Documentation/BASIC Guide/Modules, Services and Interfaces|Modules, Services and Interfaces]]
* [[Documentation/BASIC Guide/UNO Tools|Tools for Working with UNO]]
* [[Documentation/BASIC Guide/Interface Overview|Overview of Central Interfaces]]
</div>
* [[Documentation/BASIC Guide/Documents|参照文档工作]]
<div id="docs" style="display:{{{docs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/StarDesktop|The StarDesktop]]
* [[Documentation/BASIC Guide/Templates|Templates]]
</div>
* [[Documentation/BASIC Guide/Text Documents|文本文档]]
<div id="textdocs" style="display:{{{textdocs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Text Documents|The Structure of Text Documents]]
* [[Documentation/BASIC Guide/Editing Text Documents|Editing Text Documents]]
* [[Documentation/BASIC Guide/More Than Text|More than Just Text]]
</div>
* [[Documentation/BASIC Guide/Spreadsheets|数据表文档]]
<div id="spread" style="display:{{{spread|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Spreadsheets|The Structure of Spreadsheets]]
** [[Documentation/BASIC Guide/Rows and Columns|Rows and Columns]]
** [[Documentation/BASIC Guide/Cells and Ranges|Cells and Ranges]]
** [[Documentation/BASIC Guide/Formatting Spreadsheet Documents|Formatting Spreadsheet Documents]]
* [[Documentation/BASIC Guide/Editing Spreadsheet Documents|Editing Spreadsheet Documents]]
</div>
* [[Documentation/BASIC Guide/Drawings Presentations|Drawings and Presentations]]
<div id="draw" style="display:{{{draw|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Drawings|The Structure of Drawings]]
* [[Documentation/BASIC Guide/Editing Drawing Objects|Editing Drawing Objects]]
* [[Documentation/BASIC Guide/Presentations|Presentations]]
</div>
* [[Documentation/BASIC Guide/Charts|Charts (Diagrams)]]
<div id="chart" style="display:{{{chart|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Charts in Spreadsheets|Using Charts in Spreadsheets]]
* [[Documentation/BASIC Guide/Structure of Charts|The Structure of Charts]]
* [[Documentation/BASIC Guide/Chart Types|Chart Types]]
</div>
* [[Documentation/BASIC Guide/Database|Databases]]
<div id="base" style="display:{{{base|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/SQL|SQL: a Query Language]]
* [[Documentation/BASIC Guide/Database Access Types|Types of Database Access]]
* [[Documentation/BASIC Guide/Data Sources|Data Sources]]
* [[Documentation/BASIC Guide/Database Access|Database Access]]
</div>
* [[Documentation/BASIC Guide/Dialogs|Dialogs]]
<div id="dial" style="display:{{{dial|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Dialogs|Working With Dialogs]]
* [[Documentation/BASIC Guide/Properties|Properties]]
* [[Documentation/BASIC Guide/Events|Events]]
* [[Documentation/BASIC Guide/Control Elements|Dialog Control Elements]]
</div>
* [[Documentation/BASIC Guide/Forms|Forms]]
<div id="form" style="display:{{{form|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Forms|Working With Forms]]
* [[Documentation/BASIC Guide/Control Element Forms|Control Element Forms]]
* [[Documentation/BASIC Guide/Database Forms|Database Forms]]
</div>
<section end=toccontent />}}

[[Category:Documentation/BASIC Guide]]

<noinclude>
[[Category:Exclude in print|{{PAGENAME}}]]

</noinclude>[[Category:G11n Wiki Translation Testing]]

G11ntest/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Structure of Charts

2009-09-08T07:25:26Z

G11nAutomation: Created page with '{{Documentation/BASICGuideTOC/v2 |ShowPrevNext=block |ShowPrevPage=block |PrevPage=Documentation/BASIC Guide/Charts in Spreadsheets |NextPage=Documentation/BASIC Guide/Chart Type…'

{{Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Charts in Spreadsheets
|NextPage=Documentation/BASIC Guide/Chart Types
|chart=block
}}
{{DISPLAYTITLE:The Structure of Charts}}

__NOTOC__
The structure of a chart, and therefore the list of services and interfaces supported by it, depends on the chart type. For example, the methods and properties of the Z-axis, are available in 3D charts, but not in 2D charts, and in pie charts, there are no interfaces for working with axes.

== Title, Subtitle and Legend ==

Title, subtitle and legend are basic elements provided for every chart. The <tt>Chart</tt> object provides the following properties for administrating these elements:

;<tt>HasMainTitle (Boolean)</tt>:activates the title
;<tt>Title (Object)</tt>:object with detailed information about the chart title (supports the <idl>com.sun.star.chart.ChartTitle</idl> service)
;<tt>HasSubTitle(Boolean)</tt>:activates the subtitle
;<tt>Subtitle (Object)</tt>:object with detailed information about the chart subtitle (supports the <idl>com.sun.star.chart.ChartTitle</idl> service)
;<tt>HasLegend (Boolean)</tt>:activates the legend
;<tt>Legend (Object)</tt>:object with detailed information about the legend (supports the <idl>com.sun.star.chart.ChartLegend</idl> service)

Both services <tt>com.sun.star.chart.ChartTitle</tt> and <tt>com.sun.star.chart.ChartLegend</tt> do support the service <tt>com.sun.star.drawing.Shape</tt>. This allows to determine the position and size of the elements using the <tt>Position</tt> and <tt>Size</tt> properties. As the size of the legend and the titles is calculated automatically based on the current content and the character height for example, the size property provides read access only.

Fill and line properties (<idl>com.sun.star.drawing.FillProperties</idl> and <idl>com.sun.star.drawing.LineProperties</idl> services) as well as the character properties (<idl>com.sun.star.style.CharacterProperties</idl> service) are provided for further formatting of the elements.

<idl>com.sun.star.chart.ChartTitle</idl> contains not only the listed formatting properties, but also two other properties:

;<tt>String (String)</tt>:text which to be displayed as the title or subtitle
;<tt>TextRotation (Long)</tt>:angle of rotation of text in 100ths of a degree

The legend (<idl>com.sun.star.chart.ChartLegend</idl>) contains the following additional property:

;<tt>Alignment (Enum)</tt>:position at which the legend appears (value of type <idl>com.sun.star.chart.ChartLegendPosition</idl>)

The following example creates a chart with a title "Main Title String", a subtitle "Subtitle String" and a legend. The legend has a gray background color, is placed at the bottom of the chart, and has a character size of 7 points.

<source lang="oobas">
Dim Doc As Object
Dim Charts As Object
Dim Chart as Object
Dim Rect As New com.sun.star.awt.Rectangle
Dim RangeAddress(0) As New com.sun.star.table.CellRangeAddress

Rect.X = 8000
Rect.Y = 1000
Rect.Width = 10000
Rect.Height = 7000
RangeAddress(0).Sheet = 0
RangeAddress(0).StartColumn = 0
RangeAddress(0).StartRow = 0
RangeAddress(0).EndColumn = 2
RangeAddress(0).EndRow = 12

Doc = StarDesktop.CurrentComponent

Charts = Doc.Sheets(0).Charts
Charts.addNewByName("MyChart", Rect, RangeAddress(), True, True)
Chart = Charts.getByName("MyChart").EmbeddedObject
Chart.HasMainTitle = True
Chart.Title.String = "Main Title String"
Chart.HasSubTitle = True
Chart.Subtitle.String = "Subtitle String"
Chart.HasLegend = True
Chart.Legend.Alignment = com.sun.star.chart.ChartLegendPosition.BOTTOM
Chart.Legend.FillStyle = com.sun.star.drawing.FillStyle.SOLID
Chart.Legend.FillColor = RGB(210, 210, 210)
Chart.Legend.CharHeight = 7
</source>

== Background ==

Every chart has a background area. The <tt>Chart</tt> object provides the property <tt>Area</tt> to format the background:

;<tt>Area (Object)</tt>:background area of the chart (supports <idl>com.sun.star.chart.ChartArea</idl> service)

The background of a chart covers its complete area, including the area under the title, subtitle and legend. The associated <idl>com.sun.star.chart.ChartArea</idl> service supports line and fill properties.

== Diagram ==

The <tt>Chart</tt> object provides the property <tt>Diagram</tt> which forms the coordinate system with axes and grids, where the data finally is displayed:

;<tt>Diagram (Object)</tt>:object forming the coordinate system where the data is plotted. It supports <idl>com.sun.star.chart.Diagram</idl> service and:
:* <idl>com.sun.star.chart.StackableDiagram</idl>
:* <idl>com.sun.star.chart.ChartAxisXSupplier</idl>
:* <idl>com.sun.star.chart.ChartAxisYSupplier</idl>
:* <idl>com.sun.star.chart.ChartAxisZSupplier</idl>
:* <idl>com.sun.star.chart.ChartTwoAxisXSupplier</idl>
:* <idl>com.sun.star.chart.ChartTwoAxisYSupplier</idl>

Different services are supported depending on the chart type (see
[[Documentation/BASIC_Guide/Chart_Types|Chart Types]]).

== Wall and Floor ==

The chart wall is the background of the coordinate system where the data is plotted.
Two chart walls usually exist for 3D charts: one behind the plotted data and one as the left-hand or right-hand demarcation. This depends on the rotation of the chart. 3D charts usually also have a floor.

The <tt>Diagram</tt> object provides the properties Wall and Floor:

;<tt>Wall (Object)</tt>:background wall of the coordinate system (supports <idl>com.sun.star.chart.ChartArea</idl> service)
;<tt>Floor (Object)</tt>:floor panel of coordinate system (only for 3D charts, supports <idl>com.sun.star.chart.ChartArea</idl> service)

The specified objects support the <tt>com.sun.star.chart.ChartArea</tt> service, which provides the usual fill and line properties (<idl>com.sun.star.drawing.FillProperties</idl> and <idl>com.sun.star.drawing.LineProperties</idl> services, refer to [[Documentation/BASIC_Guide/Drawings_Presentations|Drawings and Presentations]]).

The following example shows how graphics (named Sky) already contained in {{OOo}} can be used as a background for a chart. The wall is set to be blue.

<source lang="oobas">
Dim Doc As Object
Dim Charts As Object
Dim Chart as Object
Dim Rect As New com.sun.star.awt.Rectangle
Dim RangeAddress(0) As New com.sun.star.table.CellRangeAddress

Rect.X = 8000
Rect.Y = 1000
Rect.Width = 10000
Rect.Height = 7000
RangeAddress(0).Sheet = 0
RangeAddress(0).StartColumn = 0
RangeAddress(0).StartRow = 0
RangeAddress(0).EndColumn = 2
RangeAddress(0).EndRow = 12

Doc = StarDesktop.CurrentComponent

Charts = Doc.Sheets(0).Charts
Charts.addNewByName("MyChart", Rect, RangeAddress(), True, True)
Chart = Charts.getByName("MyChart").EmbeddedObject
Chart.Area.FillStyle = com.sun.star.drawing.FillStyle.BITMAP
Chart.Area.FillBitmapName = "Sky"
Chart.Area.FillBitmapMode = com.sun.star.drawing.BitmapMode.REPEAT

Chart.Diagram.Wall.FillStyle = com.sun.star.drawing.FillStyle.SOLID
Chart.Diagram.Wall.FillColor = RGB(00,132,209)
</source>

== Axes ==

{{OOo}} recognizes five different axes that can be used in a chart. In the simplest scenario, these are the X and Y-axes. When working with 3D charts, a Z-axis is also sometimes provided. For charts in which the values of the various rows of data deviate significantly from one another, {{OOo}} provides a second X and Y-axis for second scaling operations.

The <tt>Diagram</tt> object provides the following properties to access the axes:

;<tt>HasXAxis (Boolean)</tt>:activates the X-axis
;<tt>XAxis (Object)</tt>:object with detailed information about the X-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasXAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the X-axis

;<tt>HasYAxis (Boolean)</tt>:activates the Y-axis
;<tt>YAxis (Object)</tt>:object with detailed information about the Y-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasYAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the Y-axis

;<tt>HasZAxis (Boolean)</tt>:activates the Z-axis
;<tt>ZAxis (Object)</tt>:object with detailed information about the Z-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasZAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the Z-axis

;<tt>HasSecondaryXAxis (Boolean)</tt>:activates the secondary X-axis
;<tt>SecondaryXAxis (Object)</tt>:object with detailed information about the secondary X-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasSecondaryXAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the secondary X-axis

;<tt>HasSecondaryYAxis (Boolean)</tt>:activates the secondary Y-axis
;<tt>SecondaryYAxis (Object)</tt>:object with detailed information about the secondary Y-axis (supports <idl>com.sun.star.chart.ChartAxis</idl> service)
;<tt>HasSecondaryYAxisDescription (Boolean)</tt>:activates the labels for the interval marks for the secondary Y-axis

== Properties of Axes ==

The axis objects of a {{OOo}} chart support the <idl>com.sun.star.chart.ChartAxis</idl> service. In addition to the properties for characters <idl>(com.sun.star.style.CharacterProperties</idl> service, refer to [[Documentation/BASIC_Guide/Text_Documents|Text Documents]]) and lines <idl>(com.sun.star.drawing.LineStyle</idl> service, refer to [[Documentation/BASIC_Guide/Drawings_Presentations|Drawings and Presentations]]), it provides the following properties:

===Scaling properties:===
;<tt>Max (Double)</tt>:maximum value for axis
;<tt>Min (Double)</tt>:minimum value for axis
;<tt>Origin (Double)</tt>:point of intersect for crossing axes
;<tt>StepMain (Double)</tt>:distance between the major interval marks
;<tt>StepHelp (Double)</tt>:distance between the minor interval marks (deprecated since OpenOffice.org 3.0; Use property StepHelpCount instead)
;<tt>StepHelpCount (Long)</tt>:Contains the number of minor intervals within a major interval. E.g. a StepHelpCount of 5 divides the major interval into 5 pieces and thus produces 4 minor tick marks. (available since OpenOffice.org 3.0)
;<tt>AutoMax (Boolean)</tt>:the maximum value for the axis is calculated automatically when set to true
;<tt>AutoMin (Boolean)</tt>:the minimum value for the axis is calculated automatically when set to true
;<tt>AutoOrigin (Boolean)</tt>:the origin is determined automatically when set to true
;<tt>AutoStepMain (Boolean)</tt>:StepMain is determined automatically when set to true
;<tt>AutoStepHelp (Boolean)</tt>:StepHelpCount is determined automatically when set to true
;<tt>Logarithmic (Boolean)</tt>:scales the axes in logarithmic manner (rather than linear)
;<tt>ReverseDirection (Boolean)</tt>:determines if the axis orientation is mathematical or reversed. (available since OpenOffice.org 2.4)

===Label properties:===
;<tt>DisplayLabels (Boolean)</tt>:activates the text label at the interval marks
;<tt>TextRotation (Long)</tt>:angle of rotation of text label in 100ths of a degree
;<tt>ArrangeOrder (enum)</tt>:the label may be staggered, thus they are positioned alternately over two lines (values according to <idl>com.sun.star.chart.ChartAxisArrangeOrderType</idl>)
;<tt>TextBreak (Boolean)</tt>:permits line breaks within the axes labels
;<tt>TextCanOverlap (Boolean)</tt>:permits an overlap of the axes labels
;<tt>NumberFormat (Long)</tt>:number format to be used with the axes labels
;<tt>LinkNumberFormatToSource (Boolean)</tt>:determines whether to use the number format given by the container document, or from the property <tt>NumberFormat</tt>. (since OpenOffice.org 2.3)

===Interval mark properties:===
;<tt>Marks (Const)</tt>:determines the position of the major interval marks (values in accordance with <idl>com.sun.star.chart.ChartAxisMarks</idl>)
;<tt>HelpMarks (Const)</tt>:determines the position of the minor interval marks (values in accordance with <idl>com.sun.star.chart.ChartAxisMarks</idl>)

===Only for bar charts:===
;<tt>Overlap (Long)</tt>:percentage which specifies the extent to which the bars of different sets of data may overlap (at 100%, the bars are shown as completely overlapping, at -100%, there is a distance of the width of one bar between them)
;<tt>GapWidth (long)</tt>:percentage which specifies the distance there may be between the different groups of bars of a chart (at 100%, there is a distance corresponding to the width of one bar)

== Grids ==

For the primary axes grids and sub grids can be displayed, matching to the major and minor intervals.
The <tt>Diagram</tt> object provides the following properties to access the grids:

;<tt>HasXAxisGrid (Boolean)</tt>:activates major grid for X-axis
;<tt>XMainGrid (Object)</tt>:object with detailed information about the major grid for X-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)
;<tt>HasXAxisHelpGrid (Boolean)</tt>:activates minor grid for X-axis
;<tt>XHelpGrid (Object)</tt>:object with detailed information about the minor grid for X-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)

the same for y and z:

;<tt>HasYAxisGrid (Boolean)</tt>:activates major grid for Y-axis
;<tt>YMainGrid (Object)</tt>:object with detailed information about the major grid for Y-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)
;<tt>HasYAxisHelpGrid (Boolean)</tt>:activates minor grid for Y-axis
;<tt>YHelpGrid (Object)</tt>:object with detailed information about the minor grid for Y-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)

;<tt>HasZAxisGrid (Boolean)</tt>:activates major grid for Z-axis
;<tt>ZMainGrid (Object)</tt>:object with detailed information about the major grid for Z-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)
;<tt>HasZAxisHelpGrid (Boolean)</tt>:activates minor grid for Z-axis
;<tt>ZHelpGrid (Object)</tt>:object with detailed information about the minor grid for Z-axis (supports <idl>com.sun.star.chart.ChartGrid</idl> service)

The grid object is based on the <idl>com.sun.star.chart.ChartGrid</idl> service, which in turn supports the line properties of the <idl>com.sun.star.drawing.LineStyle</idl> support service (refer to [[Documentation/BASIC_Guide/Drawings_Presentations|Drawings and Presentations]]).

== Axes Title ==

For all axes an additional title can be displayed.
The <tt>Diagram</tt> object provides the following properties to access the axes title:

;<tt>HasXAxisTitle (Boolean)</tt>:activates title of X-axis
;<tt>XAxisTitle (Object)</tt>:object with detailed information about title of the X-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

same y and z:

;<tt>HasYAxisTitle (Boolean)</tt>:activates title of Y-axis
;<tt>YAxisTitle (Object)</tt>:object with detailed information about title of the Y-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

;<tt>HasZAxisTitle (Boolean)</tt>:activates title of Z-axis
;<tt>ZAxisTitle (Object)</tt>:object with detailed information about title of the Z-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

and for the secondary axes (available since OpenOffice.org 3.0):

;<tt>HasSecondaryXAxisTitle (Boolean)</tt>:activates title of the secondary X-axis.
;<tt>SecondXAxisTitle (Object)</tt>:object with detailed information about title of the secondary X-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

;<tt>HasSecondaryYAxisTitle (Boolean)</tt>:activates title of the secondary Y-axis.
;<tt>SecondYAxisTitle (Object)</tt>:object with detailed information about title of the secondary Y-axis (supports <idl>com.sun.star.chart.ChartTitle</idl> service)

The objects for formatting the axes title are based on the <idl>com.sun.star.chart.ChartTitle</idl> service, which is also used for chart titles.

=== Example ===

The following example creates a line chart. The color for the rear wall of the chart is set to white. Both the X and Y-axes have a gray grid for visual orientation. The minimum value of the Y-axis is fixed to 0 and the maximum value is fixed to 100 so that the resolution of the chart is retained even if the values are changed. The X-axis points in reverse direction from right to left. And a title for the X-axis was added.

<source lang="oobas">
Dim Doc As Object
Dim Charts As Object
Dim Chart as Object
Dim Rect As New com.sun.star.awt.Rectangle
Dim RangeAddress(0) As New com.sun.star.table.CellRangeAddress

Doc = StarDesktop.CurrentComponent
Charts = Doc.Sheets(0).Charts

Rect.X = 8000
Rect.Y = 1000
Rect.Width = 10000
Rect.Height = 7000
RangeAddress(0).Sheet = 0
RangeAddress(0).StartColumn = 0
RangeAddress(0).StartRow = 0
RangeAddress(0).EndColumn = 2
RangeAddress(0).EndRow = 12

Charts.addNewByName("MyChart", Rect, RangeAddress(), True, True)
Chart = Charts.getByName("MyChart").embeddedObject
Chart.Diagram = Chart.createInstance("com.sun.star.chart.LineDiagram")
Chart.Diagram.Wall.FillColor = RGB(255, 255, 255)
Chart.Diagram.HasXAxisGrid = True
Chart.Diagram.XMainGrid.LineColor = RGB(192, 192, 192)
Chart.Diagram.HasYAxisGrid = True
Chart.Diagram.YMainGrid.LineColor = RGB(192, 192, 192)
Chart.Diagram.YAxis.Min = 0
Chart.Diagram.YAxis.Max = 100

Chart.Diagram.XAxis.ReverseDirection = true 'needs OpenOffice.org 2.4 or newer
Chart.Diagram.HasXAxisTitle = true
Chart.Diagram.XAxisTitle.String = "Reversed X Axis Example"
</source>

== 3D Charts ==

Most charts in {{OOo}} can also be displayed with 3D graphics. The following properties are provided for 3D charts at the <tt>Diagram</tt> object:

;<tt>Dim3D (Boolean)</tt>:activates 3D display
;<tt>Deep (Boolean)</tt>:the series will be arranged behind each other in z-direction
;<tt>RightAngledAxes (Boolean)</tt>:activates a 3D display mode where X- and Y-axes form a right angle within the projection. (available since OpenOffice.org 2.3)
;<tt>D3DScenePerspective (Enum)</tt>:defines whether the 3D objects are to be drawn in perspective or parallel projection.(values according to <idl>com.sun.star.drawing.ProjectionMode</idl>)
;<tt>Perspective (Long)</tt>:Perspective of 3D charts ( [0,100] ) (available since OpenOffice.org 2.4.1)
;<tt>RotationHorizontal (Long)</tt>:Horizontal rotation of 3D charts in degrees ( [-180,180] ) (available since OpenOffice.org 2.4.1)
;<tt>RotationVertical (Long)</tt>:Vertical rotation of 3D charts in degrees ( [-180,180] ) (available since OpenOffice.org 2.4.1)

The following example creates a 3D area chart.

<source lang="oobas">
Dim Doc As Object
Dim Charts As Object
Dim Chart as Object
Dim Rect As New com.sun.star.awt.Rectangle
Dim RangeAddress(0) As New com.sun.star.table.CellRangeAddress

Doc = StarDesktop.CurrentComponent
Charts = Doc.Sheets(0).Charts

Rect.X = 8000
Rect.Y = 1000
Rect.Width = 10000
Rect.Height = 7000
RangeAddress(0).Sheet = 0
RangeAddress(0).StartColumn = 0
RangeAddress(0).StartRow = 0
RangeAddress(0).EndColumn = 2
RangeAddress(0).EndRow = 12

Charts.addNewByName("MyChart", Rect, RangeAddress(), True, True)
Chart = Charts.getByName("MyChart").embeddedObject
Chart.Diagram = Chart.createInstance("com.sun.star.chart.AreaDiagram")
Chart.Diagram.Dim3D = true
Chart.Diagram.Deep = true
Chart.Diagram.RightAngledAxes = true 'needs OpenOffice.org 2.3 or newer
Chart.Diagram.D3DScenePerspective = com.sun.star.drawing.ProjectionMode.PERSPECTIVE
Chart.Diagram.Perspective = 100 'needs OpenOffice.org 2.4.1 or newer
Chart.Diagram.RotationHorizontal = 60 'needs OpenOffice.org 2.4.1 or newer
Chart.Diagram.RotationVertical = 30 'needs OpenOffice.org 2.4.1 or newer
</source>

== Stacked Charts ==

Stacked charts are charts that are arranged with several individual values on top of one another to produce a total value. This view shows not only the individual values, but also an overview of all the values.

In {{OOo}}, various types of charts can be displayed in a stacked form. All of these charts support the <idl>com.sun.star.chart.StackableDiagram</idl> service, which in turn provides the following properties:

;<tt>Stacked (Boolean)</tt>:activates the stacked viewing mode
;<tt>Percent (Boolean)</tt>:rather than absolute values, displays their percentage distribution

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide/Structure of Charts}}

{{PDL1}}[[Category:G11n Wiki Translation Testing]]

G11ntest/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Interface Overview

2009-09-08T07:25:22Z

G11nAutomation: Created page with '{{Documentation/BASICGuideTOC/v2 |ShowPrevNext=block |ShowPrevPage=block |PrevPage=Documentation/BASIC Guide/UNO Tools |NextPage=Documentation/BASIC Guide/Documents |api=block }}…'

{{Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/UNO Tools
|NextPage=Documentation/BASIC Guide/Documents
|api=block
}}
{{DISPLAYTITLE:Overview of Some Central Interfaces}}

__NOTOC__
Some interfaces of {{OOo}} can be found in many parts of the {{OOo}} API. They define sets of methods for abstract tasks which can be applied to various problems. Here, you will find an overview of the most common of these interfaces.

The origin of the objects is explained at a later point in this guide. At this point, only some of the abstract aspects of objects, for which the {{OOo}} API provides some central interfaces, are discussed.

== Creating Context-Dependent Objects ==

The {{OOo}} API provides two options for creating objects. One can be found in the <tt>createUnoService</tt> function mentioned at the start of this chapter. <tt>createUnoService</tt> creates an object which can be used universally. Such objects and services are also known as context-independent services.

In addition to context-independent services, there are also context-dependent services whose objects are only useful when used in conjunction with another object. A drawing object for a spreadsheet document, for example, can therefore only exist in conjunction with this one document.

=== <tt>com.sun.star.lang.XMultiServiceFactory</tt> Interface ===

Context-dependent objects are usually created by means of an object method, on which the object depends. The <tt>createInstance</tt> method, which is defined in the <tt>XMultiServiceFactory</tt> interface, is used in particular in the document objects.

The drawing object can, for example, be created as follows using a spreadsheet object:

<source lang="oobas">
Dim RectangleShape As Object
RectangleShape = _
Spreadsheet.createInstance("com.sun.star.drawing.RectangleShape")
</source>

A paragraph template in a text document is created in the same way:

<source lang="oobas">
Dim Style as Object
Style = Textdocument.createInstance("com.sun.star.style.ParagraphStyle")
</source>

== Named Access to Subordinate Objects ==

The <tt>XNameAccess</tt> and <tt>XNameContainer</tt> interfaces are used in objects that contain subordinate objects, which can be addressed using a natural language name.

While <tt>XNamedAccess</tt> permits access to the individual objects, <tt>XNameContainer</tt> takes on the insertion, modification and deletion of elements.

=== <tt>com.sun.star.container.XNameAccess</tt> Interface ===

An example of the use of <tt>XNameAccess</tt> is provided by the <tt>sheets</tt> object of a spreadsheet. It combines all the pages within the spreadsheet. The individual pages are accessed from the <tt>sheets</tt> object, by using the <tt>getByName</tt> method from <tt>XNameAccess</tt>:

<source lang="oobas">
Dim Sheets As Object
Dim Sheet As Object

Sheets = Spreadsheet.Sheets
Sheet = Sheets.getByName("Sheet1")
</source>

The <tt>getElementNames</tt> method provides an overview of the names of all elements. As a result, it returns a data field containing the names. The following example shows how all element names of a spreadsheet can thereby be determined and displayed in a loop:

<source lang="oobas">
Dim Sheets As Object
Dim SheetNames
Dim I As Integer

Sheets = Spreadsheet.Sheets
SheetNames = Sheets.getElementNames

For I=LBound(SheetNames) To UBound(SheetNames)
MsgBox SheetNames(I)
Next I
</source>

The <tt>hasByName</tt> method of the <tt>XNameAccess</tt> interface reveals whether a subordinate object with a particular name exists within the basic object. The following example therefore displays a message that informs the user whether the <tt>Spreadsheet</tt> object contains a page of the name <tt>Sheet1</tt>.

<source lang="oobas">
Dim Sheets As Object

Sheets = Spreadsheet.Sheets
If Sheets.HasByName("Sheet1") Then
MsgBox " Sheet1 available"
Else
MsgBox "Sheet1 not available"
End If
</source>

=== <tt>com.sun.star.container.XNameContainer</tt> Interface ===

The <tt>XNameContainer</tt> interface takes on the insertion, deletion and modification of subordinate elements in a basic object. The functions responsible are <tt>insertByName</tt>, <tt>removeByName</tt> and <tt>replaceByName</tt>.

The following is a practical example of this. It calls a text document, which contains a <tt>StyleFamilies</tt> object and uses this to in turn make the paragraph templates (ParagraphStyles) of the document available.

<source lang="oobas">
Dim StyleFamilies As Object
Dim ParagraphStyles As Object
Dim NewStyle As Object

StyleFamilies = Textdoc.StyleFamilies
ParagraphStyles = StyleFamilies.getByName("ParagraphStyles")
ParagraphStyles.insertByName("NewStyle", NewStyle)
ParagraphStyles.replaceByName("ChangingStyle", NewStyle)
ParagraphStyles.removeByName("OldStyle")
</source>

The <tt>insertByName</tt> line inserts the <tt>NewStyle</tt> style under the name of the same name in the <tt>ParagraphStyles</tt> object. The <tt>replaceByName</tt> line changes the object behind <tt>ChangingStyle</tt> into <tt>NewStyle</tt>. Finally, the <tt>removeByName</tt> call removes the object behind <tt>OldStyle</tt> from <tt>ParagraphStyles</tt>.

== Index-Based Access to Subordinate Objects ==

The <tt>XIndexAccess</tt> and <tt>XIndexContainer</tt> interfaces are used in objects which contain subordinate objects and which can be addressed using an index.

<tt>XIndexAccess</tt> provides the methods for accessing individual objects. <tt>XIndexContainer</tt> provides methods for inserting and removing elements.

=== <tt>com.sun.star.container.XIndexAccess</tt> Interface ===

<tt>XIndexAccess</tt> provides the <tt>getByIndex</tt> and <tt>getCount</tt> methods for calling the subordinate objects. <tt>getByIndex</tt> provides an object with a particular index. <tt>getCount</tt> returns how many objects are available.

<source lang="oobas">
Dim Sheets As Object
Dim Sheet As Object
Dim I As Integer

Sheets = Spreadsheet.Sheets

For I = 0 to Sheets.getCount() - 1
Sheet = Sheets.getByIndex(I)
' Editing sheet
Next I
</source>

The example shows a loop that runs through all sheet elements one after another and saves a reference to each in the <tt>Sheet</tt> object variable. When working with the indexes, note that <tt>getCount</tt> returns the number of elements. The elements in <tt>getByIndex</tt> however are numbered beginning with 0. The counting variable of the loop therefore runs from 0 to <tt>getCount()-1</tt>.

=== <tt>com.sun.star.container.XIndexContainer</tt> Interface ===

The <tt>XIndexContainer</tt> interface provides the <tt>insertByIndex</tt> and <tt>removeByIndex</tt> functions. The parameters are structured in the same way as the corresponding functions in <tt>XNameContainer</tt>.

== Iterative Access to Subordinate Objects ==

In some instances, an object may contain a list of subordinate objects that cannot be addressed by either a name or an index. In these situations, the <tt>XEnumeration</tt> and <tt>XenumerationAccess</tt> interfaces are appropriate. They provide a mechanism through which all subordinate elements of an objects can be passed, step by step, without having to use direct addressing.

=== <tt>com.sun.star.container.XEnumeration</tt> and <tt>XenumerationAccess</tt> Interfaces ===

The basic object must provide the <tt>XEnumerationAccess</tt> interface, which contains only a <tt>createEnumeration</tt> method. This returns an auxiliary object, which in turn provides the <tt>XEnumeration</tt> interface with the <tt>hasMoreElements</tt> and <tt>nextElement</tt> methods. Through these, you then have access to the subordinate objects.

The following example steps through all the paragraphs of a text:

<source lang="oobas">
Dim ParagraphEnumeration As Object
Dim Paragraph As Object

ParagraphEnumeration = Textdoc.Text.createEnumeration

While ParagraphEnumeration.hasMoreElements()
Paragraph = ParagraphEnumeration.nextElement()
Wend
</source>

The example first creates a <tt>ParagraphEnumeration</tt> auxiliary object. This gradually returns the individual paragraphs of the text in a loop. The loop is terminated as soon as the <tt>hasMoreElements</tt> method returns the <tt>False</tt> value, signaling that the end of the text has been reached.

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide/Interface Overview}}

{{PDL1}}[[Category:G11n Wiki Translation Testing]]

G11ntest/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Boolean

2009-09-08T07:25:18Z

G11nAutomation: Created page with '{{DISPLAYTITLE:Boolean Variables}} {{Documentation/BASICGuideTOC/v2 |ShowPrevNext=block |ShowPrevPage=block |PrevPage=Documentation/BASIC Guide/Numbers |NextPage=Documentation/B…'

{{DISPLAYTITLE:Boolean Variables}}

{{Documentation/BASICGuideTOC/v2
|ShowPrevNext=block
|ShowPrevPage=block
|PrevPage=Documentation/BASIC Guide/Numbers
|NextPage=Documentation/BASIC Guide/Date
|lang=block
}}

Boolean variables can only contain one of two values: <tt>True</tt> or <tt>False</tt>. They are suitable for binary specifications that can only adopt one of two statuses. A Boolean value is saved internally as a two-byte integer value, where 0 corresponds to the False and any other value to True. There is no type declaration symbol for Boolean variables. The declaration can only be made using the supplement <tt>As Boolean</tt>.

Example declaration of a Boolean variable:

<source lang="oobas">
Dim Variable As Boolean
</source>

{{InterWiki Languages BasicGuide|articletitle=Documentation/BASIC Guide/Boolean}}

{{PDL1}}[[Category:G11n Wiki Translation Testing]]

G11NWIKITEST/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Structure of Charts

2009-09-08T07:19:54Z

G11nAutomation:

G11NWIKITEST/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Interface Overview

2009-09-08T07:19:50Z

G11nAutomation:

G11NWIKITEST/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Boolean

2009-09-08T07:19:46Z

G11nAutomation:

G11NWIKITEST/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Structure of Charts

2009-09-07T13:13:46Z

G11nAutomation:

G11NWIKITEST/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Interface Overview

2009-09-07T13:13:24Z

G11nAutomation:

G11NWIKITEST/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Boolean

2009-09-07T13:13:11Z

G11nAutomation:

MediaWiki source Documentation BASIC/Template:G11NWIKITEST/Documentation/BASICGuideTOC/v2

2009-09-07T13:09:28Z

G11nAutomation:

{{Documentation/MasterTOC
|ShowPrevPage={{{ShowPrevPage}}}
|PrevPage={{{PrevPage}}}
|ShowNextPage={{{ShowNextPage}}}
|NextPage={{{NextPage}}}
|bookid=BASICGuide
|ShowParttitle=none
|ShowPrevPart=none
|ShowNextPart=none
|booktitle=[[Documentation/BASIC Guide|BASIC Guide]]
|toccontent=<section begin=toccontent />
* [[Documentation/BASIC Guide/Language|语言{{OOo}} Basic]]
<div id="lang" style="display:{{{lang|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Program Overview|Overview of a Basic Program]]
* [[Documentation/BASIC Guide/Working With Variables|Working With Variables]]
* [[Documentation/BASIC Guide/Strings|Strings]]
* [[Documentation/BASIC Guide/Numbers|Numbers]]
* [[Documentation/BASIC Guide/Boolean|Boolean Values]]
* [[Documentation/BASIC Guide/Date|Date and Time]]
* [[Documentation/BASIC Guide/Arrays|Arrays]]
* [[Documentation/BASIC Guide/Scope of Variables|Scope and Life Span of Variables]]
* [[Documentation/BASIC Guide/Constants|Constants]]
* [[Documentation/BASIC Guide/Operators|Operators]]
* [[Documentation/BASIC Guide/Branching|Branching]]
* [[Documentation/BASIC Guide/Loops|Loops]]
* [[Documentation/BASIC Guide/Procedures and Functions|Procedures and Functions]]
* [[Documentation/BASIC Guide/Error Handling|Error Handling]]
* [[Documentation/BASIC Guide/Other Instructions|Other Instructions]]
</div>
* [[Documentation/BASIC Guide/Runtime Library|Runtime Library中文]]
<div id="runtime" style="display:{{{runtime|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Conversion Functions (Runtime Library)|Conversion Functions]]
* [[Documentation/BASIC Guide/Strings (Runtime Library)|Strings]]
* [[Documentation/BASIC Guide/Date and Time (Runtime Library)|Date and Time]]
* [[Documentation/BASIC Guide/Files and Directories (Runtime Library)|Files and Directories]]
* [[Documentation/BASIC Guide/Message and Input Boxes (Runtime Library)|Message and Input Boxes]]
* [[Documentation/BASIC Guide/Other Functions (Runtime Library)|Other Functions]]
</div>
* [[Documentation/BASIC Guide/API Intro|介绍 API]]
<div id="api" style="display:{{{api|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/UNO|Universal Network Objects (UNO)]]
* [[Documentation/BASIC Guide/Properties and Methods (API)|Properties and Methods]]
* [[Documentation/BASIC Guide/Modules, Services and Interfaces|Modules, Services and Interfaces]]
* [[Documentation/BASIC Guide/UNO Tools|Tools for Working with UNO]]
* [[Documentation/BASIC Guide/Interface Overview|Overview of Central Interfaces]]
</div>
* [[Documentation/BASIC Guide/Documents|参照文档工作]]
<div id="docs" style="display:{{{docs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/StarDesktop|The StarDesktop]]
* [[Documentation/BASIC Guide/Templates|Templates]]
</div>
* [[Documentation/BASIC Guide/Text Documents|文本文档]]
<div id="textdocs" style="display:{{{textdocs|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Text Documents|The Structure of Text Documents]]
* [[Documentation/BASIC Guide/Editing Text Documents|Editing Text Documents]]
* [[Documentation/BASIC Guide/More Than Text|More than Just Text]]
</div>
* [[Documentation/BASIC Guide/Spreadsheets|数据表文档]]
<div id="spread" style="display:{{{spread|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Spreadsheets|The Structure of Spreadsheets]]
** [[Documentation/BASIC Guide/Rows and Columns|Rows and Columns]]
** [[Documentation/BASIC Guide/Cells and Ranges|Cells and Ranges]]
** [[Documentation/BASIC Guide/Formatting Spreadsheet Documents|Formatting Spreadsheet Documents]]
* [[Documentation/BASIC Guide/Editing Spreadsheet Documents|Editing Spreadsheet Documents]]
</div>
* [[Documentation/BASIC Guide/Drawings Presentations|Drawings and Presentations]]
<div id="draw" style="display:{{{draw|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Structure of Drawings|The Structure of Drawings]]
* [[Documentation/BASIC Guide/Editing Drawing Objects|Editing Drawing Objects]]
* [[Documentation/BASIC Guide/Presentations|Presentations]]
</div>
* [[Documentation/BASIC Guide/Charts|Charts (Diagrams)]]
<div id="chart" style="display:{{{chart|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Charts in Spreadsheets|Using Charts in Spreadsheets]]
* [[Documentation/BASIC Guide/Structure of Charts|The Structure of Charts]]
* [[Documentation/BASIC Guide/Chart Types|Chart Types]]
</div>
* [[Documentation/BASIC Guide/Database|Databases]]
<div id="base" style="display:{{{base|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/SQL|SQL: a Query Language]]
* [[Documentation/BASIC Guide/Database Access Types|Types of Database Access]]
* [[Documentation/BASIC Guide/Data Sources|Data Sources]]
* [[Documentation/BASIC Guide/Database Access|Database Access]]
</div>
* [[Documentation/BASIC Guide/Dialogs|Dialogs]]
<div id="dial" style="display:{{{dial|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Dialogs|Working With Dialogs]]
* [[Documentation/BASIC Guide/Properties|Properties]]
* [[Documentation/BASIC Guide/Events|Events]]
* [[Documentation/BASIC Guide/Control Elements|Dialog Control Elements]]
</div>
* [[Documentation/BASIC Guide/Forms|Forms]]
<div id="form" style="display:{{{form|none}}};margin-left: 12px;">
* [[Documentation/BASIC Guide/Working With Forms|Working With Forms]]
* [[Documentation/BASIC Guide/Control Element Forms|Control Element Forms]]
* [[Documentation/BASIC Guide/Database Forms|Database Forms]]
</div>
<section end=toccontent />}}

[[Category:Documentation/BASIC Guide]]

<noinclude>
[[Category:Exclude in print|{{PAGENAME}}]]

</noinclude>[[Category:G11n Wiki Translation Testing]]

G11NWIKITEST/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Structure of Charts

2009-09-07T13:09:22Z

G11nAutomation:

G11NWIKITEST/MediaWiki source Documentation BASIC/Documentation/BASIC Guide/Interface Overview

2009-09-07T13:09:18Z

G11nAutomation: