TargetFile Property (ConvertCtrl)

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public virtual string TargetFile {get; set;}

'Declaration
 
Public Overridable Property TargetFile As String

'Usage
 
Dim instance As ConvertCtrl
Dim value As String
 
instance.TargetFile = value
 
value = instance.TargetFile

public virtual string TargetFile {get; set;}

 get_TargetFile();
 set_TargetFile(value);

public:
virtual property String^ TargetFile {
   String^ get();
   void set (    String^ value);
}

Property Value

A string value representing the target filename.

This property allows the user to set the output of the conversion process to specified filename. If the TargetFormat property is TargetFormatType.DVD, then the TargetFile property contains the directory in which the DVD image is located. Otherwise, the TargetFile property contains the name of a media file. If the TargetFile property refers to a directory, it should contain the full path to the directory. A relative path can be used, but it is not recommended because relative paths are somewhat unpredictable. If the target format type is TargetFormatType.DVD and the TargetFile property contains the name of an existing file, that file will be deleted, and a directory or folder will be created with the same name. The filename can be used to indicate a regular file or a stream. For more details on the filename syntax, refer to: TargetFile Syntax.

Assignment can raise an error exception. For more information, refer to the Error Codes.

Visual Basic
C#
WinRT C#
WinRT JavaScript
Silverlight C#
Silverlight VB

Copy 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 175\Media";
End Class

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 175\Media";
}

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ConvertCtrl Class
ConvertCtrl Members
ResetTarget Method