diff options
| author | Alain Romedenne <alain.romedenne@libreoffice.org> | 2024-06-07 10:13:07 +0200 |
|---|---|---|
| committer | Olivier Hallot <olivier.hallot@libreoffice.org> | 2024-07-06 21:31:28 +0200 |
| commit | e859581bf5302296634127cd7bb6576f6e3ec932 (patch) | |
| tree | 53b53548be4c1f73086ed74dd7259a830bbfb0a7 /source | |
| parent | 5e39c70b93559a266ba9f68344fe8c4c3f2feacf (diff) | |
tdf#149786 tdf#161495 VBA objects & properties & methods (WiP)
- ActiveSheet object
- (Calc).ExportAsfixedFormat method
This initiates a documentation help page intended to aggregate MSOffice VBA objects
features that are currently supported.
Change-Id: I679e9a64923b69fd0d1a5ac99d39651fd8353fc7
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/168530
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Tested-by: Olivier Hallot <olivier.hallot@libreoffice.org>
Diffstat (limited to 'source')
| -rw-r--r-- | source/auxiliary/sbasic.tree | 1 | ||||
| -rw-r--r-- | source/text/sbasic/shared/main0601.xhp | 1 | ||||
| -rw-r--r-- | source/text/sbasic/shared/vba_objects.xhp | 178 |
3 files changed, 180 insertions, 0 deletions
diff --git a/source/auxiliary/sbasic.tree b/source/auxiliary/sbasic.tree index 679d849a15..ed9ac472c2 100644 --- a/source/auxiliary/sbasic.tree +++ b/source/auxiliary/sbasic.tree @@ -57,6 +57,7 @@ <topic id="sbasic/text/sbasic/shared/uno_objects.xhp">UNO Objects, Functions and Services</topic> <topic id="sbasic/text/sbasic/shared/calc_functions.xhp">Calling Calc functions</topic> <topic id="sbasic/text/sbasic/shared/special_vba_func.xhp">Exclusive VBA functions</topic> + <topic id="sbasic/text/sbasic/shared/vba_objects.xhp">VBA Supported Model</topic> <topic id="sbasic/text/sbasic/shared/03090400.xhp">Further Statements</topic> </node> <node id="07010201" title="Alphabetic List of Functions, Statements and Operators"> diff --git a/source/text/sbasic/shared/main0601.xhp b/source/text/sbasic/shared/main0601.xhp index 289dfb5ba5..72e3c47c1b 100644 --- a/source/text/sbasic/shared/main0601.xhp +++ b/source/text/sbasic/shared/main0601.xhp @@ -50,6 +50,7 @@ <h3 id="hd_id05182017030838384">Working with VBA Macros</h3> <embed href="text/sbasic/shared/vbasupport.xhp#vbamacros"/> <embed href="text/sbasic/shared/special_vba_func.xhp#exclusivevba"/> +<embed href="text/sbasic/shared/vba_objects.xhp#Title"/> <h3 id="hd_id191548155077269">Working with Macros in Python</h3> diff --git a/source/text/sbasic/shared/vba_objects.xhp b/source/text/sbasic/shared/vba_objects.xhp new file mode 100644 index 0000000000..0fdb9637d2 --- /dev/null +++ b/source/text/sbasic/shared/vba_objects.xhp @@ -0,0 +1,178 @@ +<?xml version="1.0" encoding="UTF-8"?> +<helpdocument version="1.0"> +<!-- + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at https://mozilla.org/MPL/2.0/. + * +--> + +<meta> + <topic id="textsbasicsharedvba_objectsxml" indexer="include" status="PUBLISH"> + <title id="tit" >VBA Supported Objects</title> + <filename>/text/sbasic/shared/vba_objects.xhp</filename> + </topic> +</meta> +<body> + +<section id="exclusive_vba_objects"> + <bookmark branch="index" id="bm_id051920170350145208"> + <bookmark_value>VBA Model;Introduction</bookmark_value> + <bookmark_value>VBA Model;Supported objects</bookmark_value> + </bookmark> +<h1 id="hd_id051820170313205718"><variable id="Title"><link href="text/sbasic/shared/vba_objects.xhp">VBA supported Data Model</link></variable></h1> +<paragraph id="par_id051820170314436068" role="paragraph">%PRODUCTNAME Basic adds this set of functionalies when VBA Office support is active.</paragraph> +</section> + +<paragraph id="hd_id051820170407499827" role="paragraph">These exclusive %PRODUCTNAME VBA objects properties and methods are enabled when:</paragraph> +<list type="unordered"> + <listitem> + <paragraph id="par_id731719825012469" role="listitem">• A Basic module is set with <literal>VBAModule</literal> special attribute.</paragraph> + </listitem> + <listitem> + <paragraph id="par_id851719825107422" role="listitem">• <item type="literal">Option VBASupport 1</item> compiler statement is placed before the first macro of the VBA Basic module.</paragraph> + </listitem> +</list> +<paragraph role="paragraph" id="par_id201719827126856">A few VBA objects are supported for <link href="text/sbasic/shared/vba_objects.xhp#xlsm">Excel</link>, <link href="text/sbasic/shared/vba_objects.xhp#pptm">Powerpoint</link> and <link href="text/sbasic/shared/vba_objects.xhp#docm">Word</link> application files. Limited properties and methods are available for VBA objects.</paragraph> +<embed href="text/shared/need_help.xhp#needhelp"/> + +<section id="VBACommon"> +<bookmark branch="index" id="bm_id71543455697570"> +<bookmark_value>VBA Model;Err object</bookmark_value> +</bookmark> +<h2 id="hd_id31543446449360">Common objects</h2> +</section> + +<comment> MSOffice Excel --------------------------------------------------------------------------------------</comment> + +<h2 id="par_id051820170355592581">Excel Objects, Properties and Methods</h2> + <table id="tab_id801719842343187"> + <tablerow> + <tablecell colspan="3"> + <paragraph id="par_id981719842343187" role="tablehead">Excel supported VBA objects</paragraph> + </tablecell> + </tablerow> + <tablerow> + <tablecell><paragraph id="par_id761719842343187" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/vba_objects.xhp#xlsApplication">Application</link><br/> + <link href="text/sbasic/shared/vba_objects.xhp#xlsColumns">Columns</link><br/> + </paragraph></tablecell> + <tablecell><paragraph id="par_id951719842343187" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/vba_objects.xhp#xlsRange">Range</link><br/> + <link href="text/sbasic/shared/vba_objects.xhp#xlsRows">Rows</link><br/> + </paragraph></tablecell> + <tablecell><paragraph id="par_id141719842343187" role="tablecontent" localize="false"> + <link href="text/sbasic/shared/vba_objects.xhp#xlsWorkbook">Workbook</link><br/> + <link href="text/sbasic/shared/vba_objects.xhp#xlsWorksheet">Worksheet</link><br/> + </paragraph></tablecell> + </tablerow> +</table> + +<section id="xlsApplication"> +<bookmark branch="index" id="bm_id051920170357078705"> +<bookmark_value>VBA Excel Model;Application</bookmark_value> +</bookmark> +<h3 id="hd_id61719826422710">Application</h3> + <paragraph role="paragraph" id="par_id641719824037432"><emph>Properties</emph></paragraph> + + <list type="unordered"> + <listitem><paragraph id="par_id341719823872468" role="listitem" localize="false">ActiveCell : <link href="text/sbasic/shared/vba_objects.xhp#xlsRange">Range</link></paragraph></listitem> + <listitem><paragraph id="par_id341719834972468" role="listitem" localize="false">ActiveSheet : <link href="text/sbasic/shared/vba_objects.xhp#xlsWoksheet">Worksheet</link></paragraph></listitem> + <listitem><paragraph id="par_id341820823872468" role="listitem" localize="false">ActiveWorkbook : <link href="text/sbasic/shared/vba_objects.xhp#xlsWorkbook">Workbook</link></paragraph></listitem> + <listitem><paragraph id="par_id452719823872468" role="listitem" localize="false">DefaultFilePath : String</paragraph></listitem> + <listitem><paragraph id="par_id563719823872468" role="listitem" localize="false">DisplayAlerts : Boolean</paragraph></listitem> + <listitem><paragraph id="par_id674719823872468" role="listitem" localize="false">LibraryPath : String</paragraph></listitem> + <listitem><paragraph id="par_id675829823872468" role="listitem" localize="false">Name : String</paragraph></listitem> + <listitem><paragraph id="par_id785719823872468" role="listitem">PathSeparator : String - see <link href="text/sbasic/shared/GetPathSeparator.xhp">GetPathSeparator</link> function</paragraph></listitem> + </list> + <paragraph role="paragraph" id="par_id281719824053043"><emph>Methods</emph></paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id491719824275851" role="listitem" localize="false">Quit</paragraph></listitem> + </list> +</section> + +<section id="xlsCell"> +<h3 id="hd_id361719826690873">Columns</h3> + <paragraph role="paragraph" id="par_id811719824767080"><emph>Properties</emph></paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id501719825375862" role="listitem" localize="false">Address : String</paragraph></listitem> + </list> + <paragraph role="paragraph" id="par_id561719824768137"><emph>Methods</emph></paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id141719826728738" role="listitem" localize="false">Item(ndx : Variant) : Column</paragraph></listitem> + </list> +</section> + +<section id="xlsRange"> +<bookmark branch="index" id="bm_id051920181457078705"> +<bookmark_value>VBA Excel Model;Range</bookmark_value> +</bookmark> +<h3 id="hd_id841719839364374" localize="false">Range</h3> + <paragraph role="paragraph" id="par_id851719824771480"><emph>Properties</emph></paragraph> + <paragraph role="paragraph" id="par_id591719824772015"><emph>Methods</emph></paragraph> + <list type="unordered"> + <listitem> + <paragraph id="par_id751720021450554" role="listitem" localize="false"><variable id="ExportAsFixedFormat"></variable><link href="text/sbasic/shared/exportasfixedformat.xhp">ExportAsFixedFormat</link>(Optional Type : Integer = xlTypePDF, Optional FileName : String, Optional Quality : Integer = xlQualityStandard, Optional IncludeDocProperties : Boolean, Optional IgnorePrintAreas = Boolean, Optional OpenAfterPublish : Boolean)</paragraph> + </listitem> +</list> + +</section> + +<section id="xlsRows"> +<bookmark branch="index" id="bm_id051920181457078705"> +<bookmark_value>VBA Excel Model;Rows</bookmark_value> +</bookmark> +<h3 id="hd_id952719839364374" localize="false">Rows</h3> + <paragraph role="paragraph" id="par_id851719824782580"><emph>Properties</emph></paragraph> + <paragraph role="paragraph" id="par_id591719824883015"><emph>Methods</emph></paragraph> +</section> + +<section id="xlsWorkbook"> +<bookmark branch="index" id="bm_id051920181457078705"> +<bookmark_value>VBA Excel Model;Workbook</bookmark_value> +</bookmark> +<h3 id="hd_id063719839364374" localize="false">Workbook</h3> + <paragraph role="paragraph" id="par_id851710934771480"><emph>Properties</emph></paragraph> + <paragraph role="paragraph" id="par_id591710934772015"><emph>Methods</emph></paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id252719827838738" role="listitem"><embedvar href="text/sbasic/shared/vba_objects.xhp#ExportAsFixedFormat"/></paragraph></listitem> + </list> +</section> + +<section id="xlsWorksheet"> +<bookmark branch="index" id="bm_id051920181457078705"> +<bookmark_value>VBA Excel Model;Worksheet</bookmark_value> +</bookmark> +<h3 id="hd_id174719839364374" localize="false">Worksheet</h3> + <paragraph role="paragraph" id="par_id862810934771480"><emph>Properties</emph></paragraph> + <paragraph role="paragraph" id="par_id591721034772015"><emph>Methods</emph></paragraph> + <list type="unordered"> + <listitem><paragraph id="par_id252820927838738" role="listitem"><embedvar href="text/sbasic/shared/vba_objects.xhp#ExportAsFixedFormat"/></paragraph></listitem> + </list></section> + +<comment> MSOffice Powerpoint ---------------------------------------------------------------------------------</comment> + +<bookmark branch="index" id="bm_id051920170358002074"> +<bookmark_value>VBA Powerpoint Model;Application</bookmark_value> +</bookmark> +<h2 id="par_id051820170356006501">PowerPoint Objects, Properties and Methods</h2> + +<comment> MSOffice Word ---------------------------------------------------------------------------------------</comment> + +<bookmark branch="index" id="bm_id051920170359045662"> +<bookmark_value>VBA Word;Application</bookmark_value> +</bookmark> +<h2 id="hd_id051920170347039686">Word Objects, Properties and Methods</h2> + + +<section id="relatedtopics"> +<paragraph id="par_id051720170424259343" role="paragraph" xml-lang="en-US"><link href="text/sbasic/shared/vbasupport.xhp">VBA support in %PRODUCTNAME</link></paragraph> +<paragraph id="par_id051720171119254111" role="paragraph" xml-lang="en-US"><link href="text/shared/optionen/01130100.xhp">VBA Properties</link></paragraph> +<embed href="text/sbasic/shared/special_vba_func.xhp#exclusivevba"/> +<embed href="text/sbasic/shared/03103350.xhp#vbasupportstatement"/> +</section> + +</body> +</helpdocument> |