Macro documentation

Yang Wen asked on August 8, 2016 17:31

I'm struggling a bit with Macros, specifically the seemingly poor documentation of it.

Just now I'm looking up ways to output specific rows from custom table via Macro. From the reference page here, I gathered that I can apply a Where clause via Macro. (https://docs.kentico.com/display/K8/Reference+-+Macro+methods#Reference-Macromethods-Datamanipulation). Great! However there was no documentation on how to get a collection of objects from my custom table.

From old posts here, I discovered I can get a collection from my table via GlobalObjects.CustomTables["customtable"].Items

I do a search on GlobalObjects and nothing comes up. There is no documentation on the Items property either.

I see that I can browse the Macro API in the macro editor. However that doesn't provide info on all the properties either.

Where are you guys finding the documentation on Macros?

macro

Correct Answer

Jan Hermann answered on August 9, 2016 08:07

All available macros, macro methods available objects and their properties are present in the System -> Macros -> Console application where is full tree of macro objects.

0 votesVote for this answer Unmark Correct answer

Recent Answers

Laura Frese answered on August 8, 2016 17:49

Could you use a repeater with custom query instead to show the rows of your custom table?

0 votesVote for this answer Mark as a Correct answer

Yang Wen answered on August 8, 2016 17:53 (last edited on August 8, 2016 17:56)

Yes there are other ways to achieve my goal, however with its own pros/cons.

My question is more of an attempt to get understanding of the documentation issue for macros, and using this as an example. I feel the lack of intuitive documentation is a barrier to me being more productive with this platform.

0 votesVote for this answer Mark as a Correct answer

Chetan Sharma answered on August 8, 2016 21:21 (last edited on August 8, 2016 21:21)

Hi Yang,

I agree documentation around these intricacies are not so good as compared to other sections.

These are the ones that I use

https://docs.kentico.com/display/K8/Creating+macro+rules

https://docs.kentico.com/display/K8/Entering+macro+expressions

https://docs.kentico.com/display/K8/Reference+-+Macro+methods

You may replace k8 with K9 to get version 9 documentation.

Regarding building macros, what I have observed and Kentico support might be able to attest this is that they follow the API that you normally use programatically.

It may not be true always, however more or less I have observed, that it follows the case.

Cheers, Chetan

1 votesVote for this answer Mark as a Correct answer