Welcome!

Microsoft Cloud Authors: Janakiram MSV, Yeshim Deniz, David H Deans, Andreas Grabner, Stackify Blog

Related Topics: Microsoft Cloud, PowerBuilder

Microsoft Cloud: Article

Writing COM Controls for PowerBuilder in C#

Property Pages, Persistence, and Registration Free Deployment

While there is literature describing how to use .NET controls in PB (see for example, past issues of this magazine), all are silent on how to set control properties at runtime and how to persist them. This article will address both issues.

Like regular OLE controls, you can allow your .NET control properties to be set at design-time by means of property pages (see Figure 1).

Sample Code in PB12 Resource Page
The ideas in this article have been implemented in source code available at the PB12 Resource (http://www.sybase.com/powerbuilder12). Look for "Writing A COM Control for PB using C# Part 6." This article will reference it.

Required COM Interfaces
The COM interfaces required for OLE Control property pages are the same as those required by .NET controls. The only difference being that you can implement them in C# (or VB.NET).

The interfaces required are ISpecifyPropertyPages and IPropertyPage (see Figure 2)

The ISpecifyPropertyPages interface must be implemented by the control itself. By implementing the ISpecifyPropertyPages interface, a control indicates to the hosting IDE that it supports property pages. The Control can specify any number of property pages by providing their GUIDs in the implementation of the GetPages method of ISpecifyPropertyPages. Each "page" is a tab on the property tab dialog. In Figure 3, you would get two tabs on the dialog.

For each tab on the property page dialog, you need a COM object that implements the IPropertyPage interface. In our case this would be a C# (or VB.NET) object implementing the  IPropertyPage interface (see Figures 4 and 5). This object does not have to be a control. It just needs to be a COM creatable object with GUIDs that match those specified in the implementation of ISpecifyPropertyPages (the GetPages method).

The object implementing the IPropertyPage interface creates a Control to be parented to a hosting PB IDE dialog. This control is what appears in the tabs of the property page dialog. This is done through the Activate method of the IPropertyPage interface. The title of the hosting tab page can be specified in the GetPageInfo method.  In Figure 6, a PropertyGrid control is created and made a child window of the window passed in from the Activate method. In Figure 7, the hosting tab page has its title set.

The property page will need a reference to the control being designed (whose properties are being set through the property page). This reference is needed so that when you click the "OK" button on the property page, your code can synchronize the properties of the control to the values set through the property pages (see Figure 8). This is provided for by the SetObjects method of the IPropertyPage interface.

The synchronization of the values in the property page and the property values of the control when you click the "OK" or "Apply" button is done in the Apply method of the IPropertyPage interface.

The .NET PropertyGrid Control as a Property Page
One of the advantages of implementing property pages in C# is the greater ease with which the UI can be implemented. The .NET PropertyGrid control provides (out of the box) a GUI for editing properties of .NET objects (see Figure 9). It can be customized declaratively per property using attributes on properties. It can also launch customized dialogs for properties with the System.Drawing.Design.UITypeEditor attribute. The SelectedObject property of the PropertyGrid contains the object whose properties are being edited. The property values of the object are set immediately when set in the PropertyGrid. But we want the properties to be set only when we click "OK", and not immediately, and not at all when we click "Cancel." The solution is to avoid setting the SelectedObject property to the Control. Define another object to hold the same visible properties as the control and use that object as SelectedObject instead. Synchronization between the object and the control is done during the launching of the property page dialog and when "OK" is clicked.

Alternatives to the .NET PropertyGrid
While the PropertyGrid control is the most convenient way to provide a UI to edit .NET properties, you are not limited to it. You can use Window Forms UserControls or WPF UserControls hosted in an ElementHost in a Windows Forms UserControl. The code in Figures 10 and 11 has examples of both.

Persistence
Control properties set at design-time need to be saved, so that they can be reloaded at the next design session and also at runtime. There is good news here! Control properties that are public, "scalar" (strings, numbers or enumerations) and not named "Text" (!) are automatically persisted without you having to do anything. It is also possible to suppress the persistence of selected properties. To suppress persistence for a given property, use the System.ComponentModel.DesignerSerializationVisibility attribute on the property.

Persistence of "Non-scalar" Type Properties
This is another area where the comprehensiveness of the .NET Framework makes it easy to implement COM. The framework provides several ways to turn an object into a stream of bytes and back. The most convenient form of streams of bytes for our purpose is the string. A way of doing this is with the TypeConverter: turn your properties into strings properties using System.ComponentModel.TypeConverter. See Figure 12 for an example of this.

Another approach is to use XAML as the persistence format (see Figure 13).

Conclusion
Also in the sample code are examples on how to make Control backgrounds transparent at design-time. With this article, you have everything you need to create COM controls written in C#, lacking neither runtime nor design-time features.

For those who don't like the use of "regasm" for deployment, the registration-free option is also available. See http://msdn.microsoft.com/en-us/library/ms973915.aspx for pointers on how to write the required manifests and http://blogs.msdn.com/b/astebner/archive/2006/02/28/541036.aspx on how to embed manifests as resources.

More Stories By Frederick Koh

Frederick Koh is a Staff Engineer at Sybase, Inc., and has been a member of the PowerBuilder and DataWindow.NET development team since 2005. Frederick has over 14 years of IT industry experience.

Comments (0)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


@ThingsExpo Stories
SYS-CON Events announced today that Synametrics Technologies will exhibit at SYS-CON's 22nd International Cloud Expo®, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Synametrics Technologies is a privately held company based in Plainsboro, New Jersey that has been providing solutions for the developer community since 1997. Based on the success of its initial product offerings such as WinSQL, Xeams, SynaMan and Syncrify, Synametrics continues to create and hone inn...
To get the most out of their data, successful companies are not focusing on queries and data lakes, they are actively integrating analytics into their operations with a data-first application development approach. Real-time adjustments to improve revenues, reduce costs, or mitigate risk rely on applications that minimize latency on a variety of data sources. In his session at @BigDataExpo, Jack Norris, Senior Vice President, Data and Applications at MapR Technologies, reviewed best practices to ...
With tough new regulations coming to Europe on data privacy in May 2018, Calligo will explain why in reality the effect is global and transforms how you consider critical data. EU GDPR fundamentally rewrites the rules for cloud, Big Data and IoT. In his session at 21st Cloud Expo, Adam Ryan, Vice President and General Manager EMEA at Calligo, examined the regulations and provided insight on how it affects technology, challenges the established rules and will usher in new levels of diligence arou...
Recently, WebRTC has a lot of eyes from market. The use cases of WebRTC are expanding - video chat, online education, online health care etc. Not only for human-to-human communication, but also IoT use cases such as machine to human use cases can be seen recently. One of the typical use-case is remote camera monitoring. With WebRTC, people can have interoperability and flexibility for deploying monitoring service. However, the benefit of WebRTC for IoT is not only its convenience and interopera...
The 22nd International Cloud Expo | 1st DXWorld Expo has announced that its Call for Papers is open. Cloud Expo | DXWorld Expo, to be held June 5-7, 2018, at the Javits Center in New York, NY, brings together Cloud Computing, Digital Transformation, Big Data, Internet of Things, DevOps, Machine Learning and WebRTC to one location. With cloud computing driving a higher percentage of enterprise IT budgets every year, it becomes increasingly important to plant your flag in this fast-expanding busin...
Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
No hype cycles or predictions of a gazillion things here. IoT is here. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, an Associate Partner of Analytics, IoT & Cybersecurity at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He also discussed the evaluation of communication standards and IoT messaging protocols, data...
Product connectivity goes hand and hand these days with increased use of personal data. New IoT devices are becoming more personalized than ever before. In his session at 22nd Cloud Expo | DXWorld Expo, Nicolas Fierro, CEO of MIMIR Blockchain Solutions, will discuss how in order to protect your data and privacy, IoT applications need to embrace Blockchain technology for a new level of product security never before seen - or needed.
In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and B...
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
Cloud Expo | DXWorld Expo have announced the conference tracks for Cloud Expo 2018. Cloud Expo will be held June 5-7, 2018, at the Javits Center in New York City, and November 6-8, 2018, at the Santa Clara Convention Center, Santa Clara, CA. Digital Transformation (DX) is a major focus with the introduction of DX Expo within the program. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive ov...
"Evatronix provides design services to companies that need to integrate the IoT technology in their products but they don't necessarily have the expertise, knowledge and design team to do so," explained Adam Morawiec, VP of Business Development at Evatronix, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
Recently, REAN Cloud built a digital concierge for a North Carolina hospital that had observed that most patient call button questions were repetitive. In addition, the paper-based process used to measure patient health metrics was laborious, not in real-time and sometimes error-prone. In their session at 21st Cloud Expo, Sean Finnerty, Executive Director, Practice Lead, Health Care & Life Science at REAN Cloud, and Dr. S.P.T. Krishnan, Principal Architect at REAN Cloud, discussed how they built...
Digital Transformation (DX) is not a "one-size-fits all" strategy. Each organization needs to develop its own unique, long-term DX plan. It must do so by realizing that we now live in a data-driven age, and that technologies such as Cloud Computing, Big Data, the IoT, Cognitive Computing, and Blockchain are only tools. In her general session at 21st Cloud Expo, Rebecca Wanta explained how the strategy must focus on DX and include a commitment from top management to create great IT jobs, monitor ...
"Digital transformation - what we knew about it in the past has been redefined. Automation is going to play such a huge role in that because the culture, the technology, and the business operations are being shifted now," stated Brian Boeggeman, VP of Alliances & Partnerships at Ayehu, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, led attendees through the exciting evolution of the cloud. He looked at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering m...
SYS-CON Events announced today that Evatronix will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Evatronix SA offers comprehensive solutions in the design and implementation of electronic systems, in CAD / CAM deployment, and also is a designer and manufacturer of advanced 3D scanners for professional applications.
Nordstrom is transforming the way that they do business and the cloud is the key to enabling speed and hyper personalized customer experiences. In his session at 21st Cloud Expo, Ken Schow, VP of Engineering at Nordstrom, discussed some of the key learnings and common pitfalls of large enterprises moving to the cloud. This includes strategies around choosing a cloud provider(s), architecture, and lessons learned. In addition, he covered some of the best practices for structured team migration an...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...