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



Gets or sets the height of the client area of the control.

Syntax

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

Property Value

A value representing the height.

Example

Visual BasicCopy Code
Public _result As Boolean = False
      Public _form As CaptureCtrlForm = New CaptureCtrlForm()
      Public _capturectrl As CaptureCtrl
      Public Sub ScaleHeightExample()
         ' reference the capture control
         _capturectrl = _form.CaptureCtrl

         ' output file
         Dim outFile As String = Path.Combine(LEAD_VARS.MediaDir, "CaptureCtrl_ScaleHeightExample.avi")

         Try
            ' set the source video device, select using your device name here
            If _capturectrl.VideoDevices("USB") Is Nothing Then
               Throw New Exception("No USB video device available")
            End If

            _capturectrl.VideoDevices("USB").Selected = True

            ' select a video compressor
            _capturectrl.VideoCompressors.Mpeg4.Selected = True

            ' set the target output file
            _capturectrl.TargetFile = outFile

            If _capturectrl.IsModeAvailable(CaptureMode.Video) Then

               ' subscribe to the started event
               AddHandler _capturectrl.Started, AddressOf CaptureCtrl_Started

               ' set the scale height
               _capturectrl.ScaleHeight = 100

               ' start capture
               _capturectrl.StartCapture(CaptureMode.Video)

               ' get the scale height
               Dim Height As Single = _capturectrl.ScaleHeight

               ' set the result to what we expect
               _result = (Height = 100)
            End If

         Catch e1 As Exception
            _result = False
         End Try

         ' 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 _capturectrl.State = CaptureState.Running
            Application.DoEvents()
         Loop
      End Sub

      Private Sub CaptureCtrl_Started(ByVal sender As Object, ByVal e As EventArgs)
         ' stop the capture (we don't need a complete capture for this example)
         _capturectrl.StopCapture()
      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 CaptureCtrlForm _form = new CaptureCtrlForm();
      // capture control
      CaptureCtrl capturectrl;

      // output file
      string outFile = Path.Combine(LEAD_VARS.MediaDir,"CaptureCtrl_ScaleHeightExample.avi");

      public void ScaleHeightExample()
      {
         // reference the capture control
         capturectrl = _form.CaptureCtrl;

         try
         {
            // set the source video device, select using your device name here
            if (capturectrl.VideoDevices["USB"] == null)
            {
               throw new Exception("No USB video device available");
            }

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

            // select a video compressor
            capturectrl.VideoCompressors.Mpeg4.Selected = true;

            // set the target output file
            capturectrl.TargetFile = outFile;

            if (capturectrl.IsModeAvailable(CaptureMode.Video))
            {
               // subscribe to the started event
               capturectrl.Started += CaptureCtrl_Started;

               // set the scale height
               capturectrl.ScaleHeight = 100;

               // start capture
               capturectrl.StartCapture(CaptureMode.Video);

               // get the scale height
               float Height = capturectrl.ScaleHeight;

               // set the result to what we expect
               _result = (Height == 100);
            }
         }
         catch (COMException)
         {
            _result = false;
         }
         catch (Exception)
         {
            _result = false;
         }
      }

      void CaptureCtrl_Started(object sender, EventArgs e)
      {
         // stop the capture (we don't need a complete capture for this example)
         capturectrl.StopCapture();
      }

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

Remarks

Gets or sets the height of the client area of the control. If you assign a value to this property, the actual height of the control does not change, but the current height is expressed using the value that you provide. This lets you use a custom coordinate system. For example, you can set the ScaleWidth and ScaleHeight both to 100; then express all coordinates as percentage offsets.

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