citygirl


5.0 SDK Doc Issues

I think the SDK writers are monitoring this forum so I was hoping to bring a couple of ways to improve the SDK docs to their attention.

1. On the VEMap Class page (http://msdn2.microsoft.com/en-us/library/bb429586.aspx), some methods are missing that are present on the VEMap Methods page (http://msdn2.microsoft.com/en-us/library/bb412424.aspx):

VEMap.AddShape

VEMap.AddShapeLayer

VEMap.AddTileLayer

VEMap.DeleteAllShapes

VEMap.DeleteAllShapeLayers

VEMap.DeleteShape

VEMap.DeleteShapeLayer

VEMap.GetShapeByID

VEMap.GetShapeLayerByIndex

VEMap.GetShapeLayercount

VEMap.HideInfoBox

VEMap.ShowAllShapeLayers

2. An example on how to get the shape object during a mouse event would¡¯ve saved me hours of time. I finally figured out how to do it with the help of VE¡¯s support, and will post it in a separate thread shortly. It would be great to add it to the interactive SDK.

3. On the VEMap Event Object page (http://msdn2.microsoft.com/en-us/library/bb429584.aspx) and wherever else event is described (i.e. all mouse event pages), either in the elementID or See Also section, it would really help to reference the VEMap.GetShapeByID method as a way to get the underlying shape object.

4. I tried to print class reference documents (http://msdn2.microsoft.com/en-us/library/bb412424(d=printer).aspx) from Firefox 2, and it only printed the first page (IE7 worked OK, printing all pages)

Thanks,

Jane




Re: VE5 SDK Doc Issues

SnoopDoug


Please note that these fixes will most likely not show up until the release this fall.

1. Fixed. Unfortunately there is no automated way to ensure the TOC, method/property pages, and SDK contents can stay in synch, but I will do my best.

2. The Remarks section of the VEMap Event Object Properties topic, http://msdn2.microsoft.com/en-us/library/bb429584.aspx, contains a sample that works. I know, I tried it with a simple shape. I can send you a test HTML file if you like. I will try to remember to add this to the interactive SDK.

3. See #2.

4. Yep, it's a problem. I'm not sure it is a doc problem or even a VE SDK problem. I checked a number of other MSDN topics, such as http://msdn2.microsoft.com/en-us/library/system.printing.aspx, and they have the same problem. I will see if I can find out if the MSDN folks are aware of the issue.

doug