[Solved] Making changes to the page properties

Creating a macro - Writing a Script - Using the API

[Solved] Making changes to the page properties

Postby piano1311 » Sun Jun 27, 2010 10:47 pm

Good evening,

My "macro" is nearly finished, but the last delicacy is still absent. I would be happy, to realize the following: (Sorry, I do not know the english expressions)

Format/Page/ and than make changes in
Seite - Kopfzeile - Fußzeile - Tabelle.
(For it the attachment.)

I could not find a German documentation and in addition not find a help in the English documentation, which I have. Perhaps anyone can give me a tip for an English help.

Thanks and greetings
from Germany
piano1311

Title Edited. A descriptive title for posts helps others who are searching for solutions and increases the chances of a reply (Hagar, Moderator).
Attachments
oo-format-page.jpg
Last edited by piano1311 on Wed Jun 30, 2010 9:57 pm, edited 1 time in total.
OOo 4.0.1 on Windows 8.1
piano1311
 
Posts: 68
Joined: Thu May 08, 2008 11:04 pm

Re: 2. Macro special question

Postby Zizi64 » Mon Jun 28, 2010 8:15 am

Maybe In do not understand exactly:
Do you want turn (on/off) and/or (set/edit) the Running Head and Running Foot by Basic code?
see:
viewtopic.php?f=20&t=13472
http://wiki.services.openoffice.org/wik ... rogramming
http://codesnippets.services.openoffice ... eSize.snip
http://wiki.services.openoffice.org/wik ... _Documents
http://www.oooforum.org/forum/viewtopic.phtml?t=12311



...or only want to display PageFormatDialog, and if it displayed to make changes manually:
(Recorded by MacroRecorder)
Code: Select all   Expand viewCollapse view
sub Display_PageFormatDialog
rem ----------------------------------------------------------------------
rem define variables
dim document   as object
dim dispatcher as object
rem ----------------------------------------------------------------------
rem get access to the document
document   = ThisComponent.CurrentController.Frame
dispatcher = createUnoService("com.sun.star.frame.DispatchHelper")

rem ----------------------------------------------------------------------
dispatcher.executeDispatch(document, ".uno:PageFormatDialog", "", 0, Array())

end sub
Tibor Kovacs, Hungary; LO6.1.6, 6.2.8 /Win7-10 x64Prof.
PortableApps/winPenPack: LO3.3.0-6.4.3;AOO4.1.7
Please, edit the initial post in the topic: add the word [Solved] at the beginning of the subject line - if your problem has been solved.
User avatar
Zizi64
Volunteer
 
Posts: 9308
Joined: Wed May 26, 2010 7:55 am
Location: Budapest, Hungary

Re: Making changes to the page properties

Postby piano1311 » Wed Jun 30, 2010 3:15 pm

Thanks Zizi64 and Tibor Kovacs,

sorry, I cannot find in the indicated documentations (as Zizi64 wrote), what I am looking for.
I do know the command (as Tibor Kovacs wrote ):
dispatcher.executeDispatch(document, ".uno:PageFormatDialog", "", 0, Array()),
but I wish - if possible - a little more automated.
The command opens (I have to quote the "german expressions" from the picture in my first posting)
"Seitenvorlage:Standard"
and I can change by hand: "Seite, Kopfzeile, Fußzeile".
This ist one solution.

But I have the idea, to find the special command for the macro
to change "Seite" per macro: Left, right and so on.
also to remove the hook (in german: Haken, Kreuzchen)
at "Kopfzeile" and "Fußzeile", without changing by hand.

When this is possible
thanks for an answer
piano1311
OOo 4.0.1 on Windows 8.1
piano1311
 
Posts: 68
Joined: Thu May 08, 2008 11:04 pm

Re: Making changes to the page properties

Postby Zizi64 » Wed Jun 30, 2010 3:27 pm

Zizi64 = Tibor Kovacs, it's me!


You can modify the page styles (wich contains the informations of page: for example settings of running head, running foot, etc.) by API functions. The API functions available in OOoBASIC. See the linked pages in my previous post.

There are some examples in BASIC in attached .ods file:
Running_head_macro.ods
(19.15 KiB) Downloaded 313 times
Last edited by Zizi64 on Thu Jul 01, 2010 8:20 am, edited 1 time in total.
Tibor Kovacs, Hungary; LO6.1.6, 6.2.8 /Win7-10 x64Prof.
PortableApps/winPenPack: LO3.3.0-6.4.3;AOO4.1.7
Please, edit the initial post in the topic: add the word [Solved] at the beginning of the subject line - if your problem has been solved.
User avatar
Zizi64
Volunteer
 
Posts: 9308
Joined: Wed May 26, 2010 7:55 am
Location: Budapest, Hungary

Re: Making changes to the page properties

Postby FJCC » Wed Jun 30, 2010 5:24 pm

You can change the properties of the default page style with some simple code. Here is an example that turns off the header and footer (Kopfzeile and Fußzeile) and changes the margins on the Page (Seite) tab.
Code: Select all   Expand viewCollapse view
  oStyleFamilies = ThisComponent.StyleFamilies 'ThisComponent refers to the document that called the macro
  oPageStyles = oStyleFamilies.getByName("PageStyles")  'oPageStyles is a collection of all of the Page styles
  oDefaultStyle = oPageStyles.getByName("Default")
  oDefaultStyle.HeaderOn = False  'turn off the Header
  oDefaultStyle.FooterOn = False   'turn off the footer
  oDefaultStyle.TopMargin = 1500  'set the top margin to 15 mm
  oDefaultStyle.BottomMargin = 1500
  oDefaultStyle.LeftMargin = 1500
  oDefaultStyle.RightMargin = 1500


These are just a few of the properties of the default page style that can be set with code. Here is a list of all of the properties as shown by MRI
Code: Select all   Expand viewCollapse view
(Name)                       (Value Type)                 (Value)             (Info.)   (Attr.)    (Handle) 
BackColor                    long                         -1                                       146 
BackGraphicFilter            string                       ""                                       146 
BackGraphicLocation          .style.GraphicLocation       NONE                                     146 
BackGraphicURL               string                       ""                                       146 
BackTransparent              boolean                      True                                     146 
BackgroundColor              long                         -1                                       146 
BorderDistance               long                         0                                        148 
BottomBorder                 .table.BorderLine            -STRUCT-                                 148 
BottomBorderDistance         long                         0                                        148 
BottomMargin                 long                         2000                                     155 
CenterHorizontally           boolean                      False                                    161 
CenterVertically             boolean                      False                                    162 
DisplayName                  string                       Default                       ReadOnly   1225 
FirstPageNumber              short                        1                                        175 
FooterBackColor              long                         -1                                       1227 
FooterBackGraphicFilter      string                       ""                                       1227 
FooterBackGraphicLocation    .style.GraphicLocation       NONE                                     1227 
FooterBackGraphicURL         string                       ""                                       1227 
FooterBackTransparent        boolean                      True                                     1227 
FooterBackgroundColor        long                         -1                                       1227 
FooterBodyDistance           long                         250                                      1227 
FooterBorderDistance         long                         0                                        1227 
FooterBottomBorder           .table.BorderLine            -STRUCT-                                 1227 
FooterBottomBorderDistance   long                         0                                        1227 
FooterDynamic                boolean                      True                                     1227 
FooterHeight                 long                         751                                      1227 
FooterIsDynamicHeight        boolean                      True                                     1227 
FooterIsOn                   boolean                      True                                     1227 
FooterIsShared               boolean                      True                                     1227 
FooterLeftBorder             .table.BorderLine            -STRUCT-                                 1227 
FooterLeftBorderDistance     long                         0                                        1227 
FooterLeftMargin             long                         0                                        1227 
FooterOn                     boolean                      True                                     1227 
FooterRightBorder            .table.BorderLine            -STRUCT-                                 1227 
FooterRightBorderDistance    long                         0                                        1227 
FooterRightMargin            long                         0                                        1227 
FooterShadowFormat           .table.ShadowFormat          -STRUCT-                                 1227 
FooterShared                 boolean                      True                                     1227 
FooterTopBorder              .table.BorderLine            -STRUCT-                                 1227 
FooterTopBorderDistance      long                         0                                        1227 
HeaderBackColor              long                         -1                                       1226 
HeaderBackGraphicFilter      string                       ""                                       1226 
HeaderBackGraphicLocation    .style.GraphicLocation       NONE                                     1226 
HeaderBackGraphicURL         string                       ""                                       1226 
HeaderBackTransparent        boolean                      True                                     1226 
HeaderBackgroundColor        long                         -1                                       1226 
HeaderBodyDistance           long                         250                                      1226 
HeaderBorderDistance         long                         0                                        1226 
HeaderBottomBorder           .table.BorderLine            -STRUCT-                                 1226 
HeaderBottomBorderDistance   long                         0                                        1226 
HeaderDynamic                boolean                      True                                     1226 
HeaderHeight                 long                         751                                      1226 
HeaderIsDynamicHeight        boolean                      True                                     1226 
HeaderIsOn                   boolean                      True                                     1226 
HeaderIsShared               boolean                      True                                     1226 
HeaderLeftBorder             .table.BorderLine            -STRUCT-                                 1226 
HeaderLeftBorderDistance     long                         0                                        1226 
HeaderLeftMargin             long                         0                                        1226 
HeaderOn                     boolean                      True                                     1226 
HeaderRightBorder            .table.BorderLine            -STRUCT-                                 1226 
HeaderRightBorderDistance    long                         0                                        1226 
HeaderRightMargin            long                         0                                        1226 
HeaderShadowFormat           .table.ShadowFormat          -STRUCT-                                 1226 
HeaderShared                 boolean                      True                                     1226 
HeaderTopBorder              .table.BorderLine            -STRUCT-                                 1226 
HeaderTopBorderDistance      long                         0                                        1226 
Height                       long                         27940                                    159 
ImplementationId             []byte                       -SEQUENCE-          Pseud     ReadOnly       
ImplementationName           string                       ScStyleObj          Pseud     ReadOnly       
IsBackgroundTransparent      boolean                      True                                     146 
IsLandscape                  boolean                      False                                    156 
LeftBorder                   .table.BorderLine            -STRUCT-                                 148 
LeftBorderDistance           long                         0                                        148 
LeftMargin                   long                         2000                                     154 
LeftPageFooterContent        .sheet.XHeaderFooterContent  -INTERFACE-                              181 
LeftPageHeaderContent        .sheet.XHeaderFooterContent  -INTERFACE-                              180 
Name                         string                       Default             Pseud                     
NumberingType                short                        4                                        156 
PageScale                    short                        100                                      173 
PageStyleLayout              .style.PageStyleLayout       ALL                                      156 
ParentStyle                  string                       ""                  Pseud                     
PrintAnnotations             boolean                      False                                    166 
PrintCharts                  boolean                      True                                     169 
PrintDownFirst               boolean                      True                                     172 
PrintDrawing                 boolean                      True                                     171 
PrintFormulas                boolean                      False                                    186 
PrintGrid                    boolean                      False                                    167 
PrintHeaders                 boolean                      False                                    168 
PrintObjects                 boolean                      True                                     170 
PrintZeroValues              boolean                      True                                     187 
PrinterPaperTray             string                       [From printer s...                       158 
PropertiesToDefault          []string                                         Pseud     WriteOnly       
PropertySetInfo              .beans.XPropertySetInfo      -INTERFACE-         Pseud     ReadOnly       
PropertyToDefault            string                                           Ignored                   
RightBorder                  .table.BorderLine            -STRUCT-                                 148 
RightBorderDistance          long                         0                                        148 
RightMargin                  long                         2000                                     154 
RightPageFooterContent       .sheet.XHeaderFooterContent  -INTERFACE-                              183 
RightPageHeaderContent       .sheet.XHeaderFooterContent  -INTERFACE-                              182 
ScaleToPages                 short                        0                                        174 
ScaleToPagesX                short                        0                                        188 
ScaleToPagesY                short                        0                                        188 
ShadowFormat                 .table.ShadowFormat          -STRUCT-                                 150 
Size                         .awt.Size                    -STRUCT-                                 159 
SupportedServiceNames        []string                     -Sequence-          Pseud     ReadOnly       
TopBorder                    .table.BorderLine            -STRUCT-                                 148 
TopBorderDistance            long                         0                                        148 
TopMargin                    long                         2000                                     155 
TransparentFooterBackground  boolean                      True                                     1227 
TransparentHeaderBackground  boolean                      True                                     1226 
Types                        []type                       -Sequence-          Pseud     ReadOnly       
UserDefinedAttributes        .container.XNameContainer    -INTERFACE-                              122 
Width                        long                         21590                                    159 
WritingMode                  short                        0                                        136 

Having a tool like MRI is essential for writing macros. It can be downloaded here
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.
FJCC
Moderator
 
Posts: 7651
Joined: Sat Nov 08, 2008 8:08 pm
Location: Colorado, USA

Re: Making changes to the page properties

Postby piano1311 » Wed Jun 30, 2010 9:56 pm

Thanks Tibor Kovacs and FJCC,

a) Tibor, i will study the linked pages in Your previous post.
Now I understand Your previous post

b) FJCC, StyleFamilies ... was just the way, I wanted for a quickly solution.

Greetings
a happy Macro-beginner
piano1311
OOo 4.0.1 on Windows 8.1
piano1311
 
Posts: 68
Joined: Thu May 08, 2008 11:04 pm


Return to Macros and UNO API

Who is online

Users browsing this forum: No registered users and 2 guests