Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: ui :: dialogs ::

interface XFilePickerControlAccess

Base Interface
com::sun::star::ui::dialogs::XFilePicker

Description
Provides access to the controls of a FilePicker.

A FilePicker may contain additional elements according to the needs of the different applications. These additional elements can be addressed by this interface.

See also
com::sun::star::ui::dialogs::FilePicker


Known Services which Export this Interface

com::sun::star::ui::dialogs::FilePicker

Methods' Summary

setValue Set the value of an additional element within a FilePicker.
getValue Get the value of an additional element within a FilePicker
setLabel Set the label of the specified element. If the specified element doesn't support setting a label, this method has no effect.
getLabel Returns the label of the specified element.
enableControl Enables or disables a control.

Methods' Details

setValue
 
void
setValue(
[ in ] short aControlId,
[ in ] short aControlAction,
[ in ] any aValue );

Description
Set the value of an additional element within a FilePicker.
Parameter ControlId
Identifies the element which value is to be set.
Parameter aControlAction
Specifies an action to perform with the given value. aControlAction has to be one of the values defined in ControlActions . Not all of the values are valid for all controls.
Parameter aValue
The value to set. For checkboxes aValue should be a boolean value that should be true if the checkbox should be checked and false otherwise.
See also
com::sun::star::ui::dialogs::CommonFilePickerElementIds
See also
com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
See also
com::sun::star::ui::dialogs::ControlActions
getValue
 
any
getValue(
[ in ] short aControlId,
[ in ] short aControlAction );

Description
Get the value of an additional element within a FilePicker
Parameter aControlId
Identifies the element for which value is requested.
Parameter aControlAction
Specifies which value to retrieve. aControlAction has to be one of the values defined in ControlActions . Not all of the values are valid for all controls.
Returns
The value of the specified element. If the specified control is a checkbox the returned value is a boolean that is true if the checkbox is checked false otherwise. If the specified element doesn't exist or the specified element doesn't support the specidfied control action an empty any will be returned.
See also
com::sun::star::ui::dialogs::CommonFilePickerElementIds
See also
com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
See also
com::sun::star::ui::dialogs::ControlActions
setLabel
 
void
setLabel(
[ in ] short aControlId,
[ in ] string aLabel );

Description
Set the label of the specified element. If the specified element doesn't support setting a label, this method has no effect.
Parameter aControlId
Identifies the element for which the label should be set.
Parameter aLabel
The label to be set.
See also
com::sun::star::ui::dialogs::CommonFilePickerElementIds
See also
com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
getLabel
 
string
getLabel(
[ in ] short aControlId );

Description
Returns the label of the specified element.
Parameter aControlId
Identifies the element for which the label should be returned.
Returns
The label of the specified element or an empty string if the specified element has no or supports no label or the specified element doesn't exist.
See also
com::sun::star::ui::dialogs::CommonFilePickerElementIds
See also
com::sun::star::ui::dialogs::ExtendedFilePickerElementIds
enableControl
 
void
enableControl(
[ in ] short aControlId,
[ in ] boolean bEnable );

Description
Enables or disables a control.
Parameter ControlId
Identifies the control.
Parameter bEnable

If true the specified control will be enabled.

If false the specified control will be disabled.

See also
com::sun::star::ui::dialogs::CommonFilePickerElementIds
See also
com::sun::star::ui::dialogs::ExtendedFilePickerElementIds

Top of Page