SuperScript

This documentation is still being written. Please bear with us while we complete this documentation.

The Collection Converter

It is recommended to read about modifiers prior to reading the detail on this page. Read about modifiers here.

Converts a collection of DeclarationBase objects into a string representing their concatenated client-side forms.

An implementation of this class will be processed after any implementations of the abstract class CollectionPreModifier and before any implementations of the abstract class CollectionPostModifier.

The above image demonstrates that a CollectionConverter is called after any instances of CollectionPreModifier, and is passed the output of that instance or instances.

Unlike the CollectionPreModifier and CollectionPostModifier, only one implementation of CollectionConverter is permitted in an IEmitter.

CollectionConverter Members

                        abstract class SuperScript.Modifiers.Converters.CollectionConverter
                        {
                            abstract PostModifierArgs Process(PreModifierArgs args);
                        }
                    

Name	Type	Description
Process	PostModifierArgs	Executes this instance of CollectionConverter upon the collection of DeclrationBase objects.

PostModifierArgs Members

                        class SuperScript.Modifiers.PostModifierArgs
                        {                        
                            object CustomObject { get; set; }
                            string Emitted { get; set; }
                            bool IsDebug { get; }
                        }
                    

Name	Type	Description
CustomObject	object	This property allows the user to pass any required object through the conversion process.
Emitted	string	Expected to be the output of a CollectionConverter or a previous instance of PostModifierArgs.
IsDebug	bool	Gets a value indicating whether the current HTTP request is in debug mode.

What Next?

Read about pre-conversion modifiers here.

Read about post-conversion modifiers here.

Read about HTML writers here.