Author Topic: Meaning of HTML Generation Parameters  (Read 3709 times)

Jeff Odell

  • EA User
  • **
  • Posts: 99
  • Karma: +0/-0
    • View Profile
Meaning of HTML Generation Parameters
« on: March 02, 2005, 11:07:04 am »
I'm looking for the possible values for following two parameters of the Project.RunHTMLReport:

- ImageFormat
- Style

Are they documented anywhere?

Thanks - Jeff Odell

KP

  • EA Administrator
  • EA Expert
  • *****
  • Posts: 2919
  • Karma: +54/-3
    • View Profile
Re: Meaning of HTML Generation Parameters
« Reply #1 on: March 02, 2005, 02:06:59 pm »
Never tried it, but...

The function is the same as the "Documentation | HTML Documentation" command (right-click on a package from Project View), so have a look at that dialog to see what the options are for.

Image format is either PNG or GIF, so I would try either "PNG" or "GIF" as your parameter (or try "" and see what happens).

Style specifies which web style template to use. If you use one, name it; else try "" or "<default>".

Please let us know if it works  :)
The Sparx Team
[email protected]

Jeff Odell

  • EA User
  • **
  • Posts: 99
  • Karma: +0/-0
    • View Profile
Re: Meaning of HTML Generation Parameters
« Reply #2 on: March 02, 2005, 06:16:07 pm »
Ok - by trial and error - I have found out the following regarding the parameters to Package.RunHTMLReport:

PackageGUID:
  null: the report applies to the entire model.
  GUID: the report applies only to the Project.
  Invalid GUID: the report applies to the entire model.

ExportPath:
  null: prompts for a directory.  Select one or cancel
  path: deposits the HTML in the directory
  Invalid path: a dialog box pops up

ImageFormat:
  null: Generates PNGs
  PNG: Generates PNGs
  GIF: Generates GIFs

Style
  null: Uses the default style
  Valid Web Style Template Name: Uses that template
  Invalid Web Style Template Name: Uses default

Extension
  Uses this string as the file extension for html files.
  Uses exactly what you provide it - null will cause the
  files to have no extension, otherwise whatever string
  you provide will be used.

Anyone know if there is some way to suppress any prompts?