List of Commands, properties and Methods

Creating a macro - Writing a Script - Using the API
Post Reply
User avatar
Ant
Posts: 21
Joined: Wed Oct 08, 2008 5:22 am

List of Commands, properties and Methods

Post by Ant »

I'm coding in the dark.
Where can I find a resource that lists commands, methods & properties?

I've searched oOO help and the internet but can find nothing.

I'm trying to code ooBase in Basic
OOo 3.0.X on Ms Windows XP + MS Windows Vista
FJCC
Moderator
Posts: 8642
Joined: Sat Nov 08, 2008 8:08 pm
Location: Colorado, USA

Re: List of Commands, properties and Methods

Post by FJCC »

I don't work with Base, but I can point you to some basic documentation. The official reference for the API is at http://api.openoffice.org/. Click on the IDL reference link under Developer's Guide on the left. The Developers Guide, listed under "Browse API related Documentation Online" is full of information, though the examples are mostly in JAVA.
I found both of these took some getting used to.

Andrew Pitonyak has written very useful documents for Macros. He has a web page that includes a document dedicated to database access. I think the link is
http://www.pitonyak.org/database/AndrewBase.odt

The XRay tool is indispensable for writing macros. It tells you the properties, methods, and services for any object and will bring up the API reference if you down load the SDK. It is at this link: http://ooomacros.org/dev.php#101416

I hope that can get you started. For specific questions, the people on this forum are very helpful.
Windows 10 and Linux Mint, since 2017
If your question is answered, please go to your first post, select the Edit button, and add [Solved] to the beginning of the title.
sqykly
Posts: 27
Joined: Mon Nov 24, 2008 8:28 am

Re: List of Commands, properties and Methods

Post by sqykly »

Also, most (all?) Uno objects have the properties "dbg_properties" and "dbg_methods", which return a list of properties/methods as a string. There's another property that lists supported interfaces, but if you're using Basic, you probably won't need it. If you can't find the objects to begin with, you can get almost all of them with createUnoService(servicename) for objects that are not subordinates of other objects or through thisComponent and its subordinates. If you don't know what services you're looking for in the first place, the Basic programmer's guide on the API wiki is a decent start, and the IDL reference knows almost everything.
OOo 3.0.X on Ms Windows XP
jkjambsj
Posts: 10
Joined: Wed Feb 27, 2019 10:57 am
Location: Port Elizabeth, South Africa

Re: List of Commands, properties and Methods

Post by jkjambsj »

FJCC wrote:The XRay tool is indispensable for writing macros. It tells you the properties, methods, and services for any object and will bring up the API reference if you down load the SDK. It is at this link: http://ooomacros.org/dev.php#101416
Hello - is there an updated link please for the XRay tool please? I can't find anything remotely appropriate on that page.

Thanks
Mr J Jacobs
Apache OpenOffice 4.1.2 on Windows 10 Home
LibreOffice 63.4.2 (x64) on Windows 10 Home
User avatar
RoryOF
Moderator
Posts: 33646
Joined: Sat Jan 31, 2009 9:30 pm
Location: Ireland

Re: List of Commands, properties and Methods

Post by RoryOF »

Apache OpenOffice 4.1.13 on Xubuntu 22.04.1 LTS and very infrequently on Win2K/XP
Post Reply