Welcome!

Microsoft Cloud Authors: Yeshim Deniz, Janakiram MSV, Andreas Grabner, Stackify Blog, Liz McMillan

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 DXWorldExpo has been named “Global Sponsor” of 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. Digital Transformation is the key issue driving the global enterprise IT business. Digital Transformation is most prominent among Global 2000 enterprises and government institutions.
SYS-CON Events announced today that Datera, that offers a radically new data management architecture, has been named "Exhibitor" of 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. Datera is transforming the traditional datacenter model through modern cloud simplicity. The technology industry is at another major inflection point. The rise of mobile, the Internet of Things, data storage and Big...
"We provide IoT solutions. We provide the most compatible solutions for many applications. Our solutions are industry agnostic and also protocol agnostic," explained Richard Han, Head of Sales and Marketing and Engineering at Systena America, in this SYS-CON.tv interview at @ThingsExpo, held June 6-8, 2017, at the Javits Center in New York City, NY.
"We've been engaging with a lot of customers including Panasonic, we've been involved with Cisco and now we're working with the U.S. government - the Department of Homeland Security," explained Peter Jung, Chief Product Officer at Pulzze Systems, in this SYS-CON.tv interview at @ThingsExpo, held June 6-8, 2017, at the Javits Center in New York City, NY.
SYS-CON Events announced today that Calligo, an innovative cloud service provider offering mid-sized companies the highest levels of data privacy and security, has been named "Bronze Sponsor" of 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. Calligo offers unparalleled application performance guarantees, commercial flexibility and a personalised support service from its globally located cloud plat...
Internet of @ThingsExpo, taking place October 31 - November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 21st Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The Internet of Things (IoT) is the most profound change in personal and enterprise IT since the creation of the Worldwide Web more than 20 years ago. All major researchers estimate there will be tens of billions devic...
"The Striim platform is a full end-to-end streaming integration and analytics platform that is middleware that covers a lot of different use cases," explained Steve Wilkes, Founder and CTO at Striim, in this SYS-CON.tv interview at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.
"We are focused on SAP running in the clouds, to make this super easy because we believe in the tremendous value of those powerful worlds - SAP and the cloud," explained Frank Stienhans, CTO of Ocean9, Inc., in this SYS-CON.tv interview at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.
DX World EXPO, LLC., a Lighthouse Point, Florida-based startup trade show producer and the creator of "DXWorldEXPO® - Digital Transformation Conference & Expo" has announced its executive management team. The team is headed by Levent Selamoglu, who has been named CEO. "Now is the time for a truly global DX event, to bring together the leading minds from the technology world in a conversation about Digital Transformation," he said in making the announcement.
"MobiDev is a Ukraine-based software development company. We do mobile development, and we're specialists in that. But we do full stack software development for entrepreneurs, for emerging companies, and for enterprise ventures," explained Alan Winters, U.S. Head of Business Development at MobiDev, in this SYS-CON.tv interview at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.
While the focus and objectives of IoT initiatives are many and diverse, they all share a few common attributes, and one of those is the network. Commonly, that network includes the Internet, over which there isn't any real control for performance and availability. Or is there? The current state of the art for Big Data analytics, as applied to network telemetry, offers new opportunities for improving and assuring operational integrity. In his session at @ThingsExpo, Jim Frey, Vice President of S...
SYS-CON Events announced today that DXWorldExpo has been named “Global Sponsor” of 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. Digital Transformation is the key issue driving the global enterprise IT business. Digital Transformation is most prominent among Global 2000 enterprises and government institutions.
In his opening keynote at 20th Cloud Expo, Michael Maximilien, Research Scientist, Architect, and Engineer at IBM, discussed the full potential of the cloud and social data requires artificial intelligence. By mixing Cloud Foundry and the rich set of Watson services, IBM's Bluemix is the best cloud operating system for enterprises today, providing rapid development and deployment of applications that can take advantage of the rich catalog of Watson services to help drive insights from the vast t...
SYS-CON Events announced today that EnterpriseTech has been named “Media Sponsor” of 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. EnterpriseTech is a professional resource for news and intelligence covering the migration of high-end technologies into the enterprise and business-IT industry, with a special focus on high-tech solutions in new product development, workload management, increased effic...
SYS-CON Events announced today that Massive Networks, that helps your business operate seamlessly with fast, reliable, and secure internet and network solutions, has been named "Exhibitor" of 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. As a premier telecommunications provider, Massive Networks is headquartered out of Louisville, Colorado. With years of experience under their belt, their team of...
SYS-CON Events announced today that Cloud Academy named "Bronze Sponsor" of 21st International Cloud Expo which will take place October 31 - November 2, 2017 at the Santa Clara Convention Center in Santa Clara, CA. Cloud Academy is the industry’s most innovative, vendor-neutral cloud technology training platform. Cloud Academy provides continuous learning solutions for individuals and enterprise teams for Amazon Web Services, Microsoft Azure, Google Cloud Platform, and the most popular cloud com...
SYS-CON Events announced today that Cloudistics, an on-premises cloud computing company, has been named “Bronze Sponsor” of 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. Cloudistics delivers a complete public cloud experience with composable on-premises infrastructures to medium and large enterprises. Its software-defined technology natively converges network, storage, compute, virtualization, and ...
SYS-CON Events announced today that CHEETAH Training & Innovation 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. CHEETAH Training & Innovation is a cloud consulting and IT training firm specializing in improving clients cloud strategies and infrastructures for medium to large companies.
SYS-CON Events announced today that Datanami has been named “Media Sponsor” of 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. Datanami is a communication channel dedicated to providing insight, analysis and up-to-the-minute information about emerging trends and solutions in Big Data. The publication sheds light on all cutting-edge technologies including networking, storage and applications, and thei...
The current age of digital transformation means that IT organizations must adapt their toolset to cover all digital experiences, beyond just the end users’. Today’s businesses can no longer focus solely on the digital interactions they manage with employees or customers; they must now contend with non-traditional factors. Whether it's the power of brand to make or break a company, the need to monitor across all locations 24/7, or the ability to proactively resolve issues, companies must adapt to...