Item(String) Property

C#
Visual Basic
Objective-C
Java
C++

public TargetFormat Item( 
   string name
) {get; set;}

'Declaration

Public Overloads Property Item( _
   ByVal name As String _
) As TargetFormat

'Usage

Dim instance As TargetFormats
Dim name As String
Dim value As TargetFormat
 
instance.Item(name) = value
 
value = instance.Item(name)

public:
property TargetFormat^ Item {
   TargetFormat^ get(String^ name);
   void set (String^ name, TargetFormat^ value);
}

Parameters

name: The string name of the item to get or set.

Property Value

The TargetFormat item with the specified name.

Exception	Description
System.ArgumentOutOfRangeException	The exception that is thrown when the value of an argument is outside the allowable range of values as defined by the invoked method.
System.NullReferenceException	The exception that is thrown when there is an attempt to dereference a null object reference.

This property allows access to a specific item in the collection by using the following syntax: myCollection [index]. The C# language uses the this keyword to define the indexers instead of implementing the Item property. Visual Basic implements Item as a default property, which provides the same indexing functionality. An application can use this method to find a specific target format. If the method fails, an error is raised. For more information, refer to the Error Codes.

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

Copy Code

Imports Leadtools
Imports Leadtools.Multimedia
Imports LeadtoolsMultimediaExamples.Fixtures

Public _result As Boolean = False
Public _form As CaptureCtrlForm = New CaptureCtrlForm()
Public Sub IndexContainsExample()
   ' reference the capture control
   Dim capturectrl As CaptureCtrl = _form.CaptureCtrl

   Try
      ' set an audio device first, you should use your audio device name here
      If capturectrl.AudioDevices("USB") Is Nothing Then
         Throw New Exception("No USB audio device available")
      End If

      capturectrl.AudioDevices("USB").Selected = True

      ' reference the target formats object
      Dim formats As TargetFormats = capturectrl.TargetFormats

      ' check the index using a name string
      Dim i As Integer = formats.IndexOf("WAVE")

      ' or get a target format directly, using a TargetFormatType enum
      Dim mpeg1 As TargetFormat = formats(TargetFormatType.MPEG1Audio)

      ' access the format via the collection indexer
      Dim af As TargetFormat = formats(i)

      ' check if the collection contains this format 
      ' (it should we just got it with IndexOf above)
      If formats.Contains(af) AndAlso formats.Contains(mpeg1) Then
         ' set the result to what we expect
         _result = True
      End If
   Catch e1 As Exception
      _result = False
   End Try
End Sub

using Leadtools;
using Leadtools.Multimedia;
using LeadtoolsMultimediaExamples.Fixtures;

public bool _result = false;
public CaptureCtrlForm _form = new CaptureCtrlForm();
public void IndexContainsExample()
{
   // reference the capture control
   CaptureCtrl capturectrl = _form.CaptureCtrl;

   try
   {
      // set an audio device first.  use your audio device's name here
      if (capturectrl.AudioDevices["USB"] == null)
         throw new Exception("No USB audio device available");

      capturectrl.AudioDevices["USB"].Selected = true;

      // reference the target formats object
      TargetFormats formats = capturectrl.TargetFormats;

      // check the index using a name string
      int i = formats.IndexOf("WAVE");

      // or get a target format directly, using a TargetFormatType enum
      TargetFormat mpeg1 = formats[TargetFormatType.MPEG1Audio];

      // access the format via the collection indexer
      TargetFormat af = formats[i];

      // check whether the collection contains this format 
      // (it should we just got it with IndexOf above)
      if (formats.Contains(af) && formats.Contains(mpeg1))
      {
         // set the result to what we expect
         _result = true;
      }
   }
   catch (Exception)
   {
      _result = false;
   }
}

Target Platforms

Reference

TargetFormats Class
TargetFormats Members
Overload List