SuperScript

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

The Pre-Conversion Modifier

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

The first stage in the emitter pipeline is passed an instance of PreModifierArgs and returns an instance of the same type.

The above image demonstrates how a CollectionPreModifier is the first modifying stage in the emitter pipeline, and that its output is presented to a CollectionConverter (or an additional CollectionPreModifier).

Multiple implementations of CollectionPreModifier may be added to an IEmitter. Because the CollectionPreModifier takes and returns the same object, they may be stacked in a pre-determined order, with the output from one being the input to the next.

CollectionPreModifier Members

                        abstract class SuperScript.Modifiers.Pre.CollectionPreModifier
                        {
                            abstract PreModifierArgs Process(PreModifierArgs args);
                            bool UseWhenBundled { get; set; }
                        }
                    

Name	Type	Description
Process	PreModifierArgs	Executes this instance of CollectionConverter upon the specified PreModifierArgs.
UseWhenBundled	bool	Gets or sets whether this CollectionPreModifier should be implemented when its parent IEmitter is referenced by a EmitterBundle. Read more about emitter bundles here.

PreModifierArgs Members

                        class SuperScript.Modifiers.PreModifierArgs
                        {
                            object CustomObject { get; set; }
                            IEnumerable<DeclarationBase> Declarations { get; set; }
                            bool IsDebug { get; }
                        }
                    

Name	Type	Description
CustomObject	object	This property allows the user to pass any required object through the conversion process.
Declarations	IEnumerable<DeclarationBase>	The collection of DeclarationBase objects to be processed.
IsDebug	bool	Gets a value indicating whether the current HTTP request is in debug mode.

What Next?

Read about collection converters here.

Read about post-conversion modifiers here.

Read about HTML writers here.