Hide Table of Contents
OnKeystroke Method (IPropertyManagerPage2Handler7)

Obsoleted. Superseded by IPropertyManagerPage2Handler8::OnKeystroke.

.NET Syntax

Visual Basic (Declaration) 
Function OnKeystroke( _
   ByVal Wparam As System.Integer, _
   ByVal Message As System.Integer, _
   ByVal Lparam As System.Integer, _
   ByVal Id As System.Integer _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As IPropertyManagerPage2Handler7
Dim Wparam As System.Integer
Dim Message As System.Integer
Dim Lparam As System.Integer
Dim Id As System.Integer
Dim value As System.Boolean
 
value = instance.OnKeystroke(Wparam, Message, Lparam, Id)
C# 
System.bool OnKeystroke( 
   System.int Wparam,
   System.int Message,
   System.int Lparam,
   System.int Id
)
C++/CLI 
System.bool OnKeystroke( 
&   System.int Wparam,
&   System.int Message,
&   System.int Lparam,
&   System.int Id
) 

Parameters

Wparam
wparam argument from Windows processing; indicates the keystroke that occurred

NOTE:
From the standard set of virtual keys from Windows. Refer to the Virtual Key Code information from Microsoft documentation; for example, the Alt key is VK_MENU.
Message
Message being processed by Windows; one of these values:
  • WM_KEYDOWN 0x0100

  • WM_KEYUP 0x0101

  • WM_CHAR 0x0102

  • WM_DEADCHAR 0x0103

  • WM_SYSKEYDOWN 0x0104

  • WM_SYSKEYUP 0x0105

  • WM_SYSCHAR 0x0106

  • WM_SYSDEADCHAR 0x0107

Lparam
lparam argument from Windows processing; bitmask containing various pieces of information; dependent on specific message
Id
ID of the control that has focus when the keystroke was made; this is the ID specified when the control was created in IPropertyManagerPage2::AddControl or IPropertyManagerPage2::IAddControl or IPropertyManagerPage2::AddGroupBox or IPropertyManagerPage2::IAddGroupBox.

Return Value

True indicates that the keystroke has been handled by the add-in and SOLIDWORKS should not continue to try to process it, false indicates that the keystroke has not been handled by the add-in and SOLIDWORKS will continue to try to process it

Remarks

After the add-in has finished processing the keystroke, the message continues on and is processed by Windows. Because processing must occur, nothing should be done to destroy the page nor any action performed that could disrupt normal Windows processing while the add-in is handling this keystroke.

 

To enable this functionality for this PropertyManager page, set the Options argument of ISldWorks::CreatePropertyManagerPage or ISldWorks::ICreatePropertyManagerPage to swPropertyManagerOptions_HandleKeystrokes. By default, this style is not enabled because most applications are not interested in processing keystrokes, and it is a potential performance bottleneck if lots of keystrokes are occurring.

 

See Also

Availability

SOLIDWORKS 2010 FCS, Revision Number 18.0


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   OnKeystroke Method (IPropertyManagerPage2Handler7)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:



x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2019 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.