C# Class Microsoft.R.Support.Help.Functions.SignatureInfo

Inheritance: ISignatureInfo
Show file Open project: Microsoft/RTVS Class Usage Examples

Public Methods

Method Description
GetArgumentIndex ( string argumentName, bool partialMatch ) : int

Given argument name returns index of the argument in the signature. Performs full and then partial matching fof the argument name.
GetSignatureString ( string actualName, List locusPoints = null ) : string

Creates formatted signature that is presented to the user during function parameter completion. Optionally provides locus points (locations withing the string) for each function parameter.
SignatureInfo ( string functionName ) : System

Method Details

GetArgumentIndex() public method

Given argument name returns index of the argument in the signature. Performs full and then partial matching fof the argument name.
public GetArgumentIndex ( string argumentName, bool partialMatch ) : int
argumentName string Name of the argument
partialMatch bool /// If true, partial match will be performed /// if exact match is not found ///
return int

GetSignatureString() public method

Creates formatted signature that is presented to the user during function parameter completion. Optionally provides locus points (locations withing the string) for each function parameter.
public GetSignatureString ( string actualName, List locusPoints = null ) : string
actualName string
locusPoints List
return string

SignatureInfo() public method

public SignatureInfo ( string functionName ) : System
functionName string
return System