Overlay Icons in ListView - C# Discussion Boards

Re: Overlay Icons in ListView

22-Oct-03 9:47

I've been digging deep into research for a couple days (roughly) on this and could use some help. Basically, I need to implement overlays in a ListView. The SysListVew32 (common control) supports it, but they didn't wrap this functionality in .NET so I plan on deriving my own (adding a few more things along the way) and I want to expose this functionality in a ".NET-like" manner.

The problem is that the docs are cryptic and there literally is NOT much help when googling. Seriously, try searching for "ListView LVIS_OVERLAYMASK" and you get 3 pages of hits, with only a couple hits containing any use of the mask (others are just needlessly defined constants).

So, the docs say to use ImageList_SetOverlayImage. What exactly is this doing? I give it a handle to the ImageList (no problem there), a 0-based index to an image (?) and a 1-based index to an overlay mask (?). WTF | :WTF:

The docs also state that both large and small image lists can contain overlays. With these two "helpful" tidbits in mind, can I infer that the overlay icons are in the ImageList itself? Where (at what index)? I've dug into the ImageList_SetOverlayImage function but it doesn't help.

Has anyone worked with overlay icons in a ListView? Can anyone else interpret the docs for said methods / constants? I mean, I've been working with the PSDK (and whatever it was called before) since the early 90's and I've never scratched so much hair off my head!

Anyway, I post this here because I want to do this in C# (extending our current class library). TIA

-----BEGIN GEEK CODE BLOCK-----
Version: 3.21
GCS/G/MU d- s: a- C++++ UL@ P++(+++) L+(--) E--- W+++ N++ o+ K? w++++ O- M(+) V? PS-- PE Y++ PGP++ t++@ 5 X+++ R+@ tv+ b(-)>b++ DI++++ D+ G e++>+++ h---* r+++ y+++
-----END GEEK CODE BLOCK-----

Stephane Rodriguez.22-Oct-03 12:11

Stephane Rodriguez.

22-Oct-03 12:11

Heath Stewart wrote:
I want to expose this functionality in a ".NET-like" manner.

You can derive the ListView class, or the ListViewItem class. I would also consider implementing IExtenderProvider instead since winforms are by design a bit cloaked. Nice article from Esposito in this month's MSDN mag.

Heath Stewart wrote:
So, the docs say to use ImageList_SetOverlayImage. What exactly is this doing? I give it a handle to the ImageList (no problem there), a 0-based index to an image (?) and a 1-based index to an overlay mask (?).

Looks odd but you don't have to mind. The function creates a new image in the image list by taking the passed image index, applying transparent background to it and have that image ready to use. Any time this masked image has to be used, you need to pass his index to the ImageList_Draw method (which you don't actually do if you are using a listview where you have already attached an image list ; things would be nicely taken care of in due time), and since you don't know the index of this masked image, you have to use a macro : INDEXTOOVERLAYMASK(i), where i is the index of the original non-masked image.

From your point of view, you end up creating a list view, attaching an image list to it, and then explicitely setting an overlay image to an arbitrary list view item by setting the item state. Basically with C# you would use the ListView.SetItemState(int nIndex, int nState) method, unfortunately it's internal. I think you are better off sending a Windows message instead, which is anyway what ListView.SetItemState does in the end.

// sequential layout
struct LVITEM
{
... // TODO : setup the struct
}

[DllImport("user32.dll", CharSet=CharSet.Auto)]
public static extern int SendMessage(IntPtr hWnd, int msg, int wParam, int lParam);

public const int LVM_SETITEMSTATE = 4139;
// in listview report mode only
SendMessage(listview1.Handle, LVM_SETITEMSTATE, nIndex, lvitem);

To set the overlay image, you need to appropriately fill the state field in the LVITEM structure. Only bits 8-11 are useful for the overlay. Again, the INDEXTOOVERLAYMASK macro found in commctrl.h does all this dirty bit work.

Finally, regarding overlay images, they are images that are drawn on top of item images. They differ with item images in that overlay images are masked images, i.e. a mask is applied to filter out all background color first (the color is defined when the imagelist is created).

Hope this helps.

RSS feed

Re: Overlay Icons in ListView

Heath Stewart22-Oct-03 12:20

Re: Overlay Icons in ListView

22-Oct-03 12:20

Actually, I (mostly) know all that. I've also written overlay icons for the shell. The concept is nothing new. As I said, I've been programming with the PSDK for many, many years but haven't gotten quite so deep into custom drawing a control.

One thing you said is what concerns me (since you seemed to have confirmed it). ImageList_SetOverlayIcon actually overlays the icon I specify onto the other icon (lets call it the background icon) and adds that to the image list? Ouch. I could've done that manually in my current implementation (which uses SHGetFileInfo to get icons and file type descriptions) but that could be very memory intensive. I'm guessing that this isn't the solution, then.

I figured that the overlay was only added to the icon during paint operations. Am I missing something, here. I do know from my shell extension that the icon overlay is drawn per-item (even though the item has the same icon), or so it seemed. And since the shell uses all the same classes (SysListView32 and all it's messages / notifications / structs / etc.), I figured the same.

Heath Stewart22-Oct-03 12:44

Column Name wrapping in Listview !

22-Oct-03 12:44

Okay, I've been thinking about this more and perhaps am thinking too much because I've confused myself ( I think WTF | :WTF:

)

First, are the icon overlay images (just overlays) stored in the same image list as the large and small images, or a different one initially. Second, are the overlays actually applied to the primary (background, as I think I called it in the previous message) image in the image list?

With these two questions answered, then the next question becomes: does the LVITEM.state (bits 8-11) hold the overlay imageindex or the overlay imageindex applied to the primary image?

I was planning on deriving from ListView of course, and then handling the OCM_NOTIFY message (didn't even remember the reflected messages, since only child controls like the header would send WM_NOTIFY Blush | :O

). For the CDDS_ITEMPREPAINT flag I would set the LVIS_OVERLAYMASK in LVITEM.stateMask and then the bit-shifted overlay image index in the LVITEM.state field, right? I take it that the ListView will draw this automatically since it is set appropriately? I'm confused on that one because it seems to me that it would (otherwise, why are those bits there and used?), but the one or two examples I found via google are doing the custom drawing themselves.

pahluwalia22-Oct-03 8:19

pahluwalia

22-Oct-03 8:19

Hi,

The names of the Columns in the ListView I have created are wider than the individual col. How can I make sure that the complete col name is displayed without increasing the width of every column ?

Either by increasing the height or wrapping the column names. But I don't find any property that does that !

Thanks,
Paul

Heath Stewart22-Oct-03 9:40

22-Oct-03 9:40

And you won't. You're going to have to override WndProc and delve into this with P/Invoked (and redefined structures), utilizing lots of stuff from the Platform SDK. Believe it or not, all the Windows-like controls you see in System.Windows.Forms are actually the Common Controls themselves and the Windows Forms assemblies use P/Invoked code (and redefined structures, messages, etc.) HEAVILY. Now you'll have to, too! OMG | :OMG:

pahluwalia22-Oct-03 10:26

pahluwalia

22-Oct-03 10:26

How about aligning the text that's shown in the ListViewItems to right or center ?

Can that be done !?!

Heath Stewart22-Oct-03 10:29

22-Oct-03 10:29

While aligning text in the header is easy (ColumnHeader.TextAlign), you'll once against have to override WndProc to do this. Once you do that, handle WM_CUSTOMDRAW, and redefine a few PSDK structs (like LVITEM), this is actually pretty easy.

Simplest of Things are Hard

Stephane Rodriguez.22-Oct-03 11:50

Stephane Rodriguez.

22-Oct-03 11:50

[edit]Forget what's below, this is not intended to do a column header wrapping, but only to auto-fit the width of header columns[/edit]

Instead of creating columns by passing a positive integer, pass -1 to it.

Namely, instead of writing :

listView1.Columns.Add("Very very large column name",50,System.Windows.Forms.HorizontalAlignment.Left);
listView1.Columns.Add("col2",50,System.Windows.Forms.HorizontalAlignment.Left);
listView1.Items.Add( new ListViewItem("My Item1"));

write :

listView1.Columns.Add("Very very large column name",-1,System.Windows.Forms.HorizontalAlignment.Left);
listView1.Columns.Add("col2",50,System.Windows.Forms.HorizontalAlignment.Left);
listView1.Items.Add( new ListViewItem("My Item1"));

And see how column 1 is nicely wrapped to adapt the content in columns.

PS : for your info, -1 is constant LVSCW_AUTOSIZE = -1 declared in commctrl.h

RSS feed

antoine@orchus-tech22-Oct-03 6:35

antoine@orchus-tech

22-Oct-03 6:35

Hi,

My Question Is: with regards to XML in a C# context.

For the record, I'm using VS 2002, running Win2000 dayly updated, cel400mhz,192ram,dotNET1.1

The Premices:

Put simply, I am trying to use XML as a relationnal database for an application.
I figured an XML schema, an XML file, and some code to plug it in and that was it.

The application is to store contacts information and more types of info
as we upgrade it. So what makes sense here is to have an XML file for each type of info.
The user needs to be able to do the usual, such as view, add, modify, delete entries.
The XML files should reside in the main application folder. Now, this is part of what I tried:
-please bare in mind I'm kinda new with xml... Wink | ;)

The Faulty Code:

        string item;<br />
	XmlDocument myDoc = new XmlDocument();<br />
<br />
	myDoc.Load(Application.StartupPath + "\\Contact.xml");<br />
<br />
	XmlNode myNode = myDoc.FirstChild;<br />
	item = myNode.FirstChild.InnerText.ToString();<br />
	txtFirstName.Text = item;

The Error Message:

An unhandled exception of type 'System.NullReferenceException'
occurred in Orchus_temp.exe Additional information: Object reference
not set to an instance of an object.

The Question Redux:

" How do I add, modify, view and delete data that is stored in an XML file and rendered in a C# application? "

I propose to write an article about the resolution of theses issues, since a
lot of people have to resolve these kind of problems, I believe.

So feel free to respond extensively as this will be the substace of my first article! Big Grin | :-D

Thanks!

Antoine Dubuc
Montreal, Canada

This by our hands that dream,
"I shall find a way or make one!"

leppie22-Oct-03 7:02

leppie

22-Oct-03 7:02

You can try generate a TypedDataset from the schema Smile | :)

leppie ::AllocCPArticle("Zee blog");
Seen on my Campus BBS: Linux is free...coz no-one wants to pay for it.

Philip Fitzsimons22-Oct-03 7:57

Philip Fitzsimons

22-Oct-03 7:57

myDoc.FirstChild; is the problem.
this is not a safe way to read an XML file - the first child could be a processing instruction...

you are better of using SelectSingleNode(xpath);

where xpath is the thing you want - in you case I'm guessing its "/contact/firstname" depending on you xml file structure...

"When the only tool you have is a hammer, a sore thumb you will have."

antoine@orchus-tech22-Oct-03 18:36

antoine@orchus-tech

22-Oct-03 18:36

Good.

Xpath is something new to me. I'll check that out and try it.

thank!

Antoine

This by our hands that dream,
"I shall find a way or make one!"