diff options
| author | Olivier Hallot <olivier.hallot@libreoffice.org> | 2024-03-24 17:41:40 -0300 |
|---|---|---|
| committer | Olivier Hallot <olivier.hallot@libreoffice.org> | 2024-03-25 12:54:35 +0100 |
| commit | c8ef32e905f028ee451b3664f72c0b508c74c6c5 (patch) | |
| tree | d944dbcfc20f66b1b55bce658eac30ee2058b425 | |
| parent | 7786ebca61858926ce0cd3894922dac725c1997b (diff) | |
tdf#159725 ExportAsFixedFormat Help page (WIP)
Initial Help page for ExportAsFixedFormat VBA method.
Missing:
- Error codes related
- Arguments not implemented
Change-Id: I43ca670047542b29858e4384243d7e9a36a5efc0
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/165256
Tested-by: Jenkins
Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
| -rw-r--r-- | AllLangHelp_sbasic.mk | 19 | ||||
| -rw-r--r-- | source/text/sbasic/shared/exportasfixedformat.xhp | 59 | ||||
| -rw-r--r-- | source/text/sbasic/shared/special_vba_func.xhp | 23 |
3 files changed, 81 insertions, 20 deletions
diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk index c4c51f9b1a..00484ce127 100644 --- a/AllLangHelp_sbasic.mk +++ b/AllLangHelp_sbasic.mk @@ -400,8 +400,6 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\ helpcontent2/source/text/sbasic/shared/03170010 \ helpcontent2/source/text/sbasic/shared/03170020 \ helpcontent2/source/text/sbasic/shared/05060700 \ - helpcontent2/source/text/sbasic/shared/is_keyword \ - helpcontent2/source/text/sbasic/shared/new_keyword \ helpcontent2/source/text/sbasic/shared/calc_functions \ helpcontent2/source/text/sbasic/shared/code-stubs \ helpcontent2/source/text/sbasic/shared/CallByName \ @@ -413,23 +411,26 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\ helpcontent2/source/text/sbasic/shared/Compiler_options \ helpcontent2/source/text/sbasic/shared/CreateUnoSvcWithArgs \ helpcontent2/source/text/sbasic/shared/conventions \ - helpcontent2/source/text/sbasic/shared/enum \ helpcontent2/source/text/sbasic/shared/doEvents \ + helpcontent2/source/text/sbasic/shared/enum \ helpcontent2/source/text/sbasic/shared/ErrVBA \ + helpcontent2/source/text/sbasic/shared/exportasfixedformat \ helpcontent2/source/text/sbasic/shared/fragments \ - helpcontent2/source/text/sbasic/shared/partition \ - helpcontent2/source/text/sbasic/shared/property \ - helpcontent2/source/text/sbasic/shared/replace \ - helpcontent2/source/text/sbasic/shared/uno_objects \ - helpcontent2/source/text/sbasic/shared/stardesktop \ - helpcontent2/source/text/sbasic/shared/thisdbdoc \ helpcontent2/source/text/sbasic/shared/GetPathSeparator \ + helpcontent2/source/text/sbasic/shared/is_keyword \ helpcontent2/source/text/sbasic/shared/keys \ helpcontent2/source/text/sbasic/shared/main0211 \ helpcontent2/source/text/sbasic/shared/main0601 \ + helpcontent2/source/text/sbasic/shared/new_keyword \ + helpcontent2/source/text/sbasic/shared/partition \ + helpcontent2/source/text/sbasic/shared/property \ + helpcontent2/source/text/sbasic/shared/replace \ helpcontent2/source/text/sbasic/shared/Resume \ helpcontent2/source/text/sbasic/shared/special_vba_func \ + helpcontent2/source/text/sbasic/shared/stardesktop \ helpcontent2/source/text/sbasic/shared/strconv \ + helpcontent2/source/text/sbasic/shared/thisdbdoc \ + helpcontent2/source/text/sbasic/shared/uno_objects \ helpcontent2/source/text/sbasic/shared/vbasupport \ helpcontent2/source/text/sbasic/python/main0000 \ helpcontent2/source/text/sbasic/python/python_2_basic \ diff --git a/source/text/sbasic/shared/exportasfixedformat.xhp b/source/text/sbasic/shared/exportasfixedformat.xhp new file mode 100644 index 0000000000..2705c8c865 --- /dev/null +++ b/source/text/sbasic/shared/exportasfixedformat.xhp @@ -0,0 +1,59 @@ +<?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 http://mozilla.org/MPL/2.0/. + * + --> + + <meta> + <topic id="text/sbasic/shared/exportasfixedformat.xhp" indexer="include" status="PUBLISH"> + <title id="tit">ExportAsFixedFormat</title> + <filename>/text/sbasic/shared/exportasfixedformat.xhp</filename> + </topic> +</meta> +<body> +<bookmark branch="index" id="bm_id371711286795900"> + <bookmark_value>ExportAsFixedFormat method [VBA]</bookmark_value> +</bookmark> +<section id="exportasfixedformat"> + <h1 id="hd_id981711281680887"><variable id="h1"><link href="text/sbasic/shared/exportasfixedformat.xhp">ExportAsFixedFormat Method [VBA]</link></variable></h1> + <paragraph id="par_id561711281680890" role="paragraph">Method to export a Calc document to PDF format.</paragraph> +</section> + <embed href="text/sbasic/shared/00000003.xhp#vbasupport"/> + <embed href="text/shared/need_help.xhp#needhelp"/> + + <embed href="text/sbasic/shared/00000003.xhp#functsyntax"/> + <paragraph role="code" id="par_id961711284173030">expression.ExportAsFixedFormat (Type, Filename, Quality, IncludeDocProperties, IgnorePrintAreas, From, To, OpenAfterPublish)</paragraph> + <paragraph role="paragraph" id="par_id731711284383305"><emph>Type</emph>: Integer, required. Can be either 0 or 1. <emph>0</emph> for "PDF" - Portable Document Format file (.pdf) and <emph>1</emph> for "XPS" - XPS Document (.xps)</paragraph> + <note id="par_id471711285929795">XPS export format is not supported by %PRODUCTNAME.</note> + <paragraph role="paragraph" id="par_id611711284387498"><emph>Filename</emph>: String, optional. The file name of the exported file.</paragraph> + <paragraph role="paragraph" id="par_id251711284391770"><emph>Quality</emph>: Integer, optional. Can be 0 or 1. <emph>0</emph> is for standard quality, <emph>1</emph> is for minimum quality.</paragraph> + <paragraph role="paragraph" id="par_id161711284395682"><emph>IncludeDocProperties</emph>: Boolean, optional. Set to <literal>True</literal> to indicate that document properties should be included in the exported file, or set to <literal>False</literal> to suppress the export of document properties.</paragraph> + <paragraph role="paragraph" id="par_id461711284399442"><emph>IgnorePrintAreas</emph>: Boolean, optional. If set to <literal>True</literal>, ignores any print ranges on export. If set to <literal>False</literal>, honor the print ranges on export.</paragraph> + <paragraph role="paragraph" id="par_id341711284404400"><emph>From</emph>:Integer, optional. Page number of the first page to export. If omitted, export starts at the beginning.</paragraph> + <paragraph role="paragraph" id="par_id21711284409841"><emph>To</emph>: Integer, optional. Page number of the last page to export. If omitted, export ends with the last page.</paragraph> + <paragraph role="paragraph" id="par_id461711284415267"><emph>OpenAfterPublish</emph>:Boolean, optional. If set to <literal>True</literal>, displays the file in the proper viewer after export. On <literal>False</literal>, the file is exported but not displayed.</paragraph> + + <embed href="text/sbasic/shared/00000003.xhp#functexample"/> + <bascode> + <paragraph role="bascode" id="par_id921711287715213" localize="false">Option VBASupport 1</paragraph> + <paragraph role="bascode" id="par_id601711287720548" localize="false">Sub ExportAsPDF()</paragraph> + <paragraph role="bascode" id="par_id221711287732684" localize="false"> ActiveSheet.ExportAsFixedFormat _</paragraph> + <paragraph role="bascode" id="par_id391711287743852" localize="false"> Type:=0, _</paragraph> + <paragraph role="bascode" id="par_id871711287752660" localize="false"> Filename:=".\ExportAsPDF.pdf", _</paragraph> + <paragraph role="bascode" id="par_id331711287757251" localize="false"> Quality:=0, _</paragraph> + <paragraph role="bascode" id="par_id141711287762403" localize="false"> IncludeDocProperties:=True, _</paragraph> + <paragraph role="bascode" id="par_id591711287767283" localize="false"> IgnorePrintAreas:=False, _</paragraph> + <paragraph role="bascode" id="par_id291711287773955" localize="false"> OpenAfterPublish:=True</paragraph> + <paragraph role="bascode" id="par_id761711287783131" localize="false">End Sub</paragraph> + </bascode> + <section id="relatedtopics"> + <embed href="text/sbasic/shared/special_vba_func.xhp#exclusivevba"/> +</section> +</body> +</helpdocument> + diff --git a/source/text/sbasic/shared/special_vba_func.xhp b/source/text/sbasic/shared/special_vba_func.xhp index d8acdcbac9..7e3a2060aa 100644 --- a/source/text/sbasic/shared/special_vba_func.xhp +++ b/source/text/sbasic/shared/special_vba_func.xhp @@ -20,24 +20,24 @@ <meta> <topic id="textsbasicsharedspecial_vba_funcxml" indexer="include" status="PUBLISH"> - <title id="tit" xml-lang="en-US">Exclusive VBA functions</title> + <title id="tit">Exclusive VBA functions</title> <filename>/text/sbasic/shared/special_vba_func.xhp</filename> </topic> </meta> <body> <section id="exclusive_vba_functions"> -<bookmark xml-lang="en-US" branch="index" id="bm_id051920170350145208"> +<bookmark branch="index" id="bm_id051920170350145208"> <bookmark_value>VBA Functions;Introduction</bookmark_value> </bookmark> <h1 id="hd_id051820170313205718"><variable id="exclusivevba"><link href="text/sbasic/shared/special_vba_func.xhp">Exclusive VBA Functions and Statements</link></variable></h1> -<paragraph id="par_id051820170314436068" role="paragraph" xml-lang="en-US"><ahelp hid=".">%PRODUCTNAME Basic adds this set of functions when VBA support is enabled.</ahelp></paragraph> +<paragraph id="par_id051820170314436068" role="paragraph"><ahelp hid=".">%PRODUCTNAME Basic adds this set of functions when VBA support is enabled.</ahelp></paragraph> </section> -<paragraph id="hd_id051820170407499827" role="paragraph" xml-lang="en-US">These exclusive VBA functions are enabled when the statement <item type="literal">Option VBASupport 1</item> is placed before the first macro of a %PRODUCTNAME Basic module. </paragraph> +<paragraph id="hd_id051820170407499827" role="paragraph">These exclusive VBA functions are enabled when the statement <item type="literal">Option VBASupport 1</item> is placed before the first macro of a %PRODUCTNAME Basic module. </paragraph> <section id="vbastatements"> -<bookmark xml-lang="en-US" branch="index" id="bm_id71543455697570"> +<bookmark branch="index" id="bm_id71543455697570"> <bookmark_value>VBA Statements</bookmark_value> </bookmark> <h2 id="hd_id31543446449360">VBA Statements</h2> @@ -48,7 +48,7 @@ </section> <section id="VBAString"> -<bookmark xml-lang="en-US" branch="index" id="bm_id05192017035621676"> +<bookmark branch="index" id="bm_id05192017035621676"> <bookmark_value>VBA Functions;Text Functions</bookmark_value> </bookmark> <h2 id="par_id051820170355592834">Text functions</h2> @@ -60,7 +60,7 @@ </section> <section id="VBAFinancial"> -<bookmark xml-lang="en-US" branch="index" id="bm_id051920170357078705"> +<bookmark branch="index" id="bm_id051920170357078705"> <bookmark_value>VBA Functions;Financial Functions</bookmark_value> </bookmark> <h2 id="par_id051820170355592581">Financial functions</h2> @@ -80,7 +80,7 @@ </section> <section id="VBADateTime"> -<bookmark xml-lang="en-US" branch="index" id="bm_id051920170358102074"> +<bookmark branch="index" id="bm_id051920170358102074"> <bookmark_value>VBA Functions;Date and Time Functions</bookmark_value> </bookmark> <h2 id="par_id051820170356005357">Date and time functions</h2> @@ -90,16 +90,17 @@ </section> <section id="VBAIO"> -<bookmark xml-lang="en-US" branch="index" id="bm_id051920170358002074"> +<bookmark branch="index" id="bm_id051920170358002074"> <bookmark_value>VBA Functions;I/O Functions</bookmark_value> </bookmark> <h2 id="par_id051820170356006501">I/O Functions</h2> <embed href="text/sbasic/shared/03160000.xhp#Input"/> +<embed href="text/sbasic/shared/exportasfixedformat.xhp#exportasfixedformat"/> </section> <section id="VBAMath"> -<bookmark xml-lang="en-US" branch="index" id="bm_id051920170358346963"> +<bookmark branch="index" id="bm_id051920170358346963"> <bookmark_value>VBA Functions;Mathematical Functions</bookmark_value> <bookmark_value>VBA Functions;formatting numbers</bookmark_value> <bookmark_value>VBA Functions;partitioning numbers</bookmark_value> @@ -112,7 +113,7 @@ </section> <section id="VBAObject"> -<bookmark xml-lang="en-US" branch="index" id="bm_id051920170359045662"> +<bookmark branch="index" id="bm_id051920170359045662"> <bookmark_value>VBA Functions;Object Properties and Methods</bookmark_value> </bookmark> <h2 id="hd_id051920170347039686">Object Properties and Methods</h2> |