CommonMessages

public static class CommonMessages
Exposes common standard message texts, infos and actions.

Methods

ClipIndex

#
public static MessageDelegate ClipIndex(IParameter parameter)
Create the standard action which enables the clipping mode on integer parameters.
Parameters:
parameter (IParameter)Must be an IntegerParameter with IntegerParameter.IsIndex=true.

IndexingActions

#
public static MessageDelegate[] IndexingActions(IParameter parameter)
Create all three standard indexing actions (Clip, Wrap, and Ping).
Parameters:
parameter (IParameter)

IndexTooHighInfo

#
public static string IndexTooHighInfo(IParameter parameter)
Gets the standard index-too-high message info taylored for the given parameter.
Parameters:
parameter (IParameter)

IndexTooHighText

#
public static string IndexTooHighText(IParameter parameter)
Gets the standard index-too-high message text.
Parameters:
parameter (IParameter)

IndexTooLowInfo

#
public static string IndexTooLowInfo(IParameter parameter)
Gets the standard index-too-low message info taylored for the given parameter.
Parameters:
parameter (IParameter)

IndexTooLowText

#
public static string IndexTooLowText(IParameter parameter)
Gets the standard index-too-low message text.
Parameters:
parameter (IParameter)

InvalidCurveLocusInfo

#
public static string InvalidCurveLocusInfo(IParameter parameter, CurveLocus locus)
Gets the standard info for invalid curve loci.
Parameters:
parameter (IParameter)
locus (CurveLocus)

InvalidCurveLocusText

#
public static string InvalidCurveLocusText(IParameter parameter)
Gets the standard text for invalid curve loci.
Parameters:
parameter (IParameter)

InvalidDataInfo

#
public static string InvalidDataInfo(IParameter parameter, string description = null)
Gets the standard invalid value message info.
Parameters:
parameter (IParameter)
description (string = null)

InvalidDataText

#
public static string InvalidDataText(IParameter parameter)
Gets the standard invalid value message text.
Parameters:
parameter (IParameter)

LongestLists

#
public static MessageDelegate LongestLists(IEnumerable<IParameter> parameters, IDocumentObject affectedObject, params IDocumentObject[] additionalObjects)
Create the standard action which runs all data coming into the specified parameters through a LONGEST LIST component first.
Parameters:
parameters (IEnumerable<IParameter>)
affectedObject (IDocumentObject)
additionalObjects (params IDocumentObject[])

NoLocalDataInfo

#
public static string NoLocalDataInfo(IParameter parameter)
The info for missing local data messages.
Parameters:
parameter (IParameter)

NoLocalDataText

#
public static string NoLocalDataText(IParameter parameter)
The text for missing local data messages.
Parameters:
parameter (IParameter)

NoRemoteDataInfo

#
public static string NoRemoteDataInfo(IParameter parameter)
The info for missing inherited data messages.
Parameters:
parameter (IParameter)

NoRemoteDataText

#
public static string NoRemoteDataText(IParameter parameter)
The text for missing inherited data messages.
Parameters:
parameter (IParameter)

PingIndex

#
public static MessageDelegate PingIndex(IParameter parameter)
Create the standard action which enables the pinging mode on integer parameters.
Parameters:
parameter (IParameter)Must be an IntegerParameter with IntegerParameter.IsIndex=true.

ShortestLists

#
public static MessageDelegate ShortestLists(IEnumerable<IParameter> parameters, IDocumentObject affectedObject, params IDocumentObject[] additionalObjects)
Create the standard action which runs all data coming into the specified parameters through a SHORTEST LIST component first.
Parameters:
parameters (IEnumerable<IParameter>)
affectedObject (IDocumentObject)
additionalObjects (params IDocumentObject[])

UnknownCurveInfo

#
public static string UnknownCurveInfo(Type type)
Gets the standard info for curve data without an assistant.
Parameters:
type (Type)

UnknownCurveText

#
public static string UnknownCurveText(IParameter parameter)
Gets the standard text for curve data without an assistant.
Parameters:
parameter (IParameter)

UnknownTypeInfo

#
public static string UnknownTypeInfo(Type type)
Gets the standard info for data without an assistant.
Parameters:
type (Type)

UnknownTypeText

#
public static string UnknownTypeText(IParameter parameter)
Gets the standard text for data without an assistant.
Parameters:
parameter (IParameter)

WrapIndex

#
public static MessageDelegate WrapIndex(IParameter parameter)
Create the standard action which enables the wrapping mode on integer parameters.
Parameters:
parameter (IParameter)Must be an IntegerParameter with IntegerParameter.IsIndex=true.