GetProgressorCaption

Description

This event handler needs to return the current progress window caption, so it can be restored after a sub-operation has changed the caption and completed.

For instance:
AVI exporting (progressor event id=9 - see FBEditor::ProgressorEventEx) has a sub-operation : mixing sounds to one track for inclusion in the AVI (event id = 19).

FBEditor will call SetProgressorCaption at the start of the export to set the caption for the progress dialog to "Exporting to AVI", then call GetProgressorCaption before starting the sound mix operation. It calls SetProgressorCaption again at the start of sound mixing to change the caption to "Mixing sounds" (or similar), and once the sub-operation is complete, restores the progress window caption to whatever was returned from the previous call to GetProgressorCaption.

Syntax

[C#/C++]
public String GetProgressorCaption ()

[VB.NET]
Public Function GetProgressorCaption () As String
 

Setting the event handler

[C#]
fbEditor.GetProgressorCaption += new IFBEditorEvents_GetProgressorCaptionEventHandler(EditorGetProgressorCaption);
 

[VB]
AddHandler fbEditor.GetProgressorCaption, AddressOf EditorGetProgressorCaption
 

[Delphi]
FBEditor.OnGetProgressorCaption := EditorGetProgressorCaption;
 

[C++ Builder]
Editor->OnGetProgressorCaption = EditorGetProgressorCaption;

 

See Also

FBEditor::PlayEvent   FBEditor::ProgressorEvent  FBEditor::SetProgressorCaption  FBEditor::ProgressorEventEx