ToolProperties Complex Type

The ToolProperties type describes the overall properties of the tool.

Syntax

<ToolProperties>
  <DefaultFormID />
  <DefaultFormName />
  <DefaultViewID />
  <DefaultViewName />
  <AllowSearch />
  <AllowRecordCreation />
  <AllowMacros />
  <AllowChangeView />
  <ViewStyle />
  <DefaultFormURI />
  <DefaultViewURI />
  <DesignTemplateName />
  <DesignTemplateVersion />
  <AboutToolContents />
</ToolProperties>

Complex Type Elements

Element	Data type	Description
DefaultFormID	xs:string	Provides the ID of the default form.
DefaultFormName	xs:string	Provides the display name of the default form.
DefaultViewID	xs:string	Provides the ID of the default view.
DefaultViewName	xs:string	Provides the display name of the default view.
AllowSearch	xs:boolean	Specifies whether the Forms tool designer grants the workspace members the ability to search for records through the Groove user interface. This property does not control whether the QueryRecords operation can be used.
AllowRecordCreation	xs:boolean	Specifies whether the Forms tool designer chose to have the tool display the menu to create new records. This property has no relationship to whether the current user has permission to create records using the CreateRecords operation.
AllowMacros	xs:boolean	Specifies whether the Forms tool designer grants the workspace members the ability to execute macros.
AllowChangeView	xs:boolean	Specifies whether the Forms tool designer grants the workspace members the ability to select different views within the tool.
ViewStyle	xs:string	Specifies whether the Forms tool designer grants the workspace members the ability to display multiple records using a data view. If the designer does not grant them this ability, workspace members will be able to display only a single document at a time using a form view.
DefaultFormURI	xs:anyURI	Provides the URI of the default view. This URI can be used as the target of the ReadFormFields operation and can be used in the QueryRecords operation.
DefaultViewURI	xs:anyURI	Provides the URI of the default view. This can be used in the QueryRecords operation.
DesignTemplateName	xs:string	The Design Template Name that is entered by the Forms designer on the Settings and Options About This Tool tab. Forms designers can use the Design Template Name field to specify a name to identify all instances of Forms tools created from the same template. The following lists the forms tools and their design template names for the forms tool templates available from the Groove 2007 Add Tool menu: Discusion tool has the design template name urn:groove.net.platform.tools.forms.CustomizableDiscussion. Issue tracking tool has the design template name urn:groove.net.platform.tools.forms.IssueTracker.
DesignTemplateVersion	xs:string	The Design Template Version that is entered by the Forms designer on the Settings and Options About This Tool tab. Forms designers can use the Design Template Version field to identify the version number of the template used to create the instance of the Forms tool.
AboutToolContents	xs:string	The text that is entered by the Forms designer on the Settings and Options About This Tool tab.

See Also

Reference

GrooveForms2 Web Service
GrooveForms2.ReadToolProperties Operation

Concepts

Accessing Forms Tool Design Information