:: com :: sun :: star :: ucb ::

service HelpContent
Description
A Help Content represents either a directory object allowing access to a search engine and to index information for the respective module, or an object allowing access to the concrete written help content.
See also
HelpContentProvider

Exported Interfaces
::com::sun::star::lang::XComponent
Description
This interface is implemented according to the specification of service Content .
XContent
Description
This interface is implemented according to the specification of service Content .
XCommandProcessor
Description
This interface is implemented according to the specification of service Content .

Supported Commands

  • getCommandInfo
  • getPropertySetInfo
  • getPropertyValues
  • setPropertyValues
  • open
Supported Properties
  • string ContentType ( read-only, ""application/vnd.sun.star.help" )
  • boolean IsReadOnly ( read-only, always "true" )
  • boolean IsDocument ( read-only )
  • boolean IsFolder ( read-only )
  • string Title ( read-only, content title )
  • string MediaType ( read only, either "image/gif", "text/plain", "text/html" or "text/css" )
  • sequence<string> KeywordList ( read-only, only if IsFolder is true, contains the index )
  • sequence<sequence<string>> KeywordRef ( read-only, only if IsFolder is true, contains the links belonging to the index )
  • sequence<sequence<string>> KeywordAnchorForRef ( read-only, only if IsFolder is true, contains the anchor names belonging to the index )
  • sequence<sequence<string>> KeywordTitleForRef ( read-only, , only if IsFolder is true, contains the titles of the documents in which the keywords are found. )
  • sequence<string> SearchScopes ( read only, , only if IsFolder is true, contains the scopes in which to search ).
  • string AnchorName ( readonly, only if content is has media type "text/html".

XCommandProcessor2
Usage Restrictions
optional
Description
is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via XCommandProcessor::createCommandIdentifier to avoid resource leaks. For a detailed description of the problem refer to XCommandProcessor2::releaseCommandIdentifier .

Where many existing Content implementations do not (yet), every new implementation should support this interface.

::com::sun::star::beans::XPropertiesChangeNotifier
Description
This interface is implemented according to the specification of service Content .
::com::sun::star::beans::XPropertyContainer
Description
This interface is implemented according to the specification of service Content .
::com::sun::star::beans::XPropertySetInfoChangeNotifier
Description
This interface is implemented according to the specification of service Content .
XCommandInfoChangeNotifier
Description
This interface is implemented according to the specification of service Content .
::com::sun::star::container::XChild
Description
This interface is implemented according to the specification of service Content .

 
Top of Page