Behavior: MethodSignature

posted Jul 7, 2014, 10:48 AM by Kevin Cassidy   [ updated Jul 14, 2014, 4:57 PM ]
Parameters can easily be configured by a user for method, services, and statement calls.

<i class="icon-list" data-behavior="MethodSignature" data-methodsignature-options="{
    'moduleid': 'MethodObject',
    'operationid': 'MethodOperation',
    'parameterid': 'MethodParameters'
}"/>

The options passed to the behavior comprise:
  • moduleid: id of html element that has the method class name
  • operationid: id of html element that has the method operation
  • parameterid: id of html element in which the parameters should be set
  • url: URL of method to supply list of parameters
    • Default is Application/ObjectConfiguration.ashx/ParameterList
Defining parameters:
  • Method parameters
    • Use the method comment section to define items with term and description attributes
    • AbstractObject/Pivot as example
  • Statement parameters
    • Provide a Description attribute
  • Service parameters
    • Provide Parameters/Parameter nodes, as with Statements, to define parameters for a Service
    • Provide a Description attribute
  • Fields
    • Field description is available when commented in the {Object}.Fields.cs appropriately
Use case:
  • Template custom methods
  • Workflow steps
Comments