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



index
The zero-based index of the item to get or set.
Gets or sets the TargetFormat item at the specified index.

Syntax

Visual Basic (Declaration) 
Overloads Public Property Item( _
   ByVal index As Integer _
) As TargetFormat
Visual Basic (Usage)Copy Code
Dim instance As TargetFormats
Dim index As Integer
Dim value As TargetFormat
 
instance.Item(index) = value
 
value = instance.Item(index)
C# 
public TargetFormat Item( 
   int index
) {get; set;}
C++/CLI 
public:
property TargetFormat^ Item {
   TargetFormat^ get(int index);
   void set (int indexTargetFormat^ value);
}

Parameters

index
The zero-based index of the item to get or set.

Property Value

The TargetFormat item at the specified index.

Exceptions

ExceptionDescription
System.ArgumentOutOfRangeException 

Example

Visual BasicCopy Code
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
C#Copy Code
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, you should use your audio device 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 if 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;
   }
}

Remarks

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.

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