LEADTOOLS Multimedia (Leadtools.Multimedia assembly) Send comments on this topic. | Back to Introduction | Help Version 17.0.3.22
Preview Property
See Also 
Leadtools.Multimedia Namespace > ConvertCtrl Class : Preview Property



Gets or sets the convert controls preview state.

Syntax

Visual Basic (Declaration) 
Public Overridable Property Preview As Boolean
Visual Basic (Usage)Copy Code
Dim instance As ConvertCtrl
Dim value As Boolean
 
instance.Preview = value
 
value = instance.Preview
C# 
public virtual bool Preview {get; set;}
C++/CLI 
public:
virtual property bool Preview {
   bool get();
   void set (    bool value);
}

Property Value

true if Preview is enabled: otherwise it is false.

Example

Visual BasicCopy Code
Public _result As Boolean = False
      Public _form As ConvertCtrlForm = New ConvertCtrlForm()
      Public Sub HasDialogExample()
         ' reference the convert control
         Dim convertctrl As ConvertCtrl = _form.ConvertCtrl

         ' input and output files
         Dim inFile As String = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_Source.avi")
         Dim outFile As String = Path.Combine(LEAD_VARS.MediaDir, "ConvertCtrl_HasDialogExample.avi")

         Try
            ' set the source for conversion
            convertctrl.SourceFile = inFile

            ' set the video and audio compressors
            convertctrl.VideoCompressors.Mpeg2.Selected = True
            convertctrl.AudioCompressors.AC3.Selected = True

            ' set the target output file and format
            convertctrl.TargetFile = outFile

            ' set the target output format
            convertctrl.TargetFormat = TargetFormatType.AVI

            ' The HasDialog method tells us that the control
            ' can display the desired settings dialog.
            ' check to see if the convert source dialog is available
            If convertctrl.HasDialog(ConvertDlg.TargetFormat) Then
               ' now show it
               convertctrl.ShowDialog(ConvertDlg.TargetFormat, _form)
               _result = True
            End If

            ' start the capture process
            convertctrl.StartConvert()

            ' we'll loop on the state and pump messages for this example.
            ' but you should not need to if running from a Windows Forms application.
            Do While convertctrl.State = ConvertState.Running
               Application.DoEvents()
            Loop

            ' see if there was an error
            If convertctrl.ConvertError <> 0 Then
               ' set the result to false
               _result = False
            End If
         Catch e1 As Exception
            _result = False
         End Try
      End Sub

Public NotInheritable Class LEAD_VARS
   Public Const MediaDir As String = "C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 17\Media"
End Class
C#Copy Code
public bool _result = false;
      public ConvertCtrlForm _form = new ConvertCtrlForm();
      public void HasDialogExample()
      {
         // reference the convert control
         ConvertCtrl convertctrl = _form.ConvertCtrl;

         // input and output files
         string inFile = Path.Combine(LEAD_VARS.MediaDir,"ConvertCtrl_Source.avi");
         string outFile = Path.Combine(LEAD_VARS.MediaDir,"ConvertCtrl_HasDialogExample.avi");

         try
         {
            // set the source for conversion
            convertctrl.SourceFile = inFile;

            // set the video and audio compressors
            convertctrl.VideoCompressors.Mpeg2.Selected = true;
            convertctrl.AudioCompressors.AC3.Selected = true;

            // set the target output file and format
            convertctrl.TargetFile = outFile;

            // set the target output format
            convertctrl.TargetFormat = TargetFormatType.AVI;

            // The HasDialog method tells us that the control
            // can display the desired settings dialog.
            // check to see if the convert source dialog is available
            if (convertctrl.HasDialog(ConvertDlg.TargetFormat))
            {
               // now show it
               convertctrl.ShowDialog(ConvertDlg.TargetFormat, _form);
               _result = true;
            }

            // start the capture process
            convertctrl.StartConvert();

            // we'll loop on the state and pump messages for this example.
            // but you should not need to if running from a Windows Forms application.
            while (convertctrl.State == ConvertState.Running)
               Application.DoEvents();

            // see if there was an error
            if (convertctrl.ConvertError != 0)
            {
               // set the result to false
               _result = false;
            }
         }
         catch (Exception)
         {
            _result = false;
         }
      }

static class LEAD_VARS
{
   public const string MediaDir = @"C:\Program Files (x86)\LEAD Technologies\LEADTOOLS 17\Media";
}

Remarks

The default value is false.

If the property fails, an error is raised. For more information, refer to the Error Codes.

Note: When setting this property, the convert control must be in the stopped state.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also