/// <summary>
/// Returns <see cref="IRowObject"/> as an HTML string with or without HTML headers.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="includeHtmlHeaders"></param>
/// <returns></returns>
public static string TransformToHtmlString(IRowObject rowObject, bool includeHtmlHeaders)
{
if (rowObject == null)
{
throw new ArgumentNullException("Parameter cannot be null.", "rowObject");
}
string html = "";
html += includeHtmlHeaders ? GetHtmlHeader() : "";
html += GetPageHeader(rowObject.GetType().ToString());
html += GetHtmlForObject(rowObject, HtmlOutputType.Table);
if (rowObject.Fields != null)
{
html += "<h2>Fields</h2>";
html += "<table>";
html += GetHtmlForObject(rowObject.Fields.FirstOrDefault(), HtmlOutputType.TableHeaders);
foreach (FieldObject fieldObject in rowObject.Fields)
{
html += GetHtmlForObject(fieldObject, HtmlOutputType.TableRow);
}
html += "</table>";
}
html += includeHtmlHeaders ? GetHtmlFooter() : "";
return(html);
}
/// <summary>
/// Sets the <see cref="IFieldObject"/> in a <see cref="IRowObject"/> as enabled by FieldNumber.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumber"></param>
/// <returns></returns>
public static IRowObject SetEnabledField(IRowObject rowObject, string fieldNumber)
{
if (rowObject == null)
{
throw new ArgumentNullException("Parameter cannot be null.", "rowObject");
}
return(SetFieldObject(rowObject, FieldAction.Enable, fieldNumber));
}
/// <summary>
/// Returns <see cref="IRowObject"/> as an HTML string without HTML headers.
/// </summary>
/// <param name="rowObject"></param>
/// <returns></returns>
public static string TransformToHtmlString(IRowObject rowObject)
{
if (rowObject == null)
{
throw new ArgumentNullException("Parameter cannot be null.", "rowObject");
}
return(TransformToHtmlString(rowObject, false));
}
/// <summary>
/// Sets the <see cref="IFieldObject"/> in a <see cref="IRowObject"/> as optional by FieldNumber.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumber"></param>
/// <returns></returns>
public static IRowObject SetOptionalField(IRowObject rowObject, string fieldNumber)
{
if (rowObject == null)
{
throw new ArgumentNullException(nameof(rowObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
return(SetFieldObject(rowObject, FieldAction.Optional, fieldNumber));
}
/// <summary>
/// Sets the <see cref="IFieldObject"/> in a <see cref="IRowObject"/> as disabled by FieldNumbers.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumbers"></param>
/// <returns></returns>
public static IRowObject SetDisabledFields(IRowObject rowObject, List <string> fieldNumbers)
{
if (rowObject == null)
{
throw new ArgumentNullException(nameof(rowObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
return(SetFieldObjects(rowObject, FieldAction.Disable, fieldNumbers));
}
/// <summary>
/// Sets the <see cref="IFieldObject"/> in a <see cref="IRowObject"/> as optional by FieldNumbers.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumbers"></param>
/// <returns></returns>
public static IRowObject SetOptionalFields(IRowObject rowObject, List <string> fieldNumbers)
{
if (rowObject == null)
{
throw new ArgumentNullException("Parameter cannot be null.", "rowObject");
}
return(SetFieldObjects(rowObject, FieldAction.Optional, fieldNumbers));
}
/// <summary>
/// Returns <see cref="IRowObject"/> as an HTML string without HTML headers.
/// </summary>
/// <param name="rowObject"></param>
/// <returns></returns>
public static string TransformToHtmlString(IRowObject rowObject)
{
if (rowObject == null)
{
throw new ArgumentNullException(nameof(rowObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
return(TransformToHtmlString(rowObject, false));
}
public static IRowObject Clone(IRowObject rowObject)
{
if (rowObject == null)
{
throw new ArgumentNullException("The parameter cannot be null.", "rowObject");
}
return(TransformToRowObject(rowObject.ToJson()));
}
/// <summary>
/// Adds a <see cref="IFieldObject"/> to a <see cref="IRowObject"/> using supplied FieldNumber and FieldValue.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumber"></param>
/// <param name="fieldValue"></param>
/// <returns></returns>
public static IRowObject AddFieldObject(IRowObject rowObject, string fieldNumber, string fieldValue)
{
if (rowObject == null)
{
throw new System.ArgumentNullException(nameof(rowObject));
}
if (string.IsNullOrEmpty(fieldNumber))
{
throw new System.ArgumentNullException(nameof(fieldNumber), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
return(AddFieldObject(rowObject, fieldNumber, fieldValue, false, false, false));
}
/// <summary>
/// Adds a <see cref="IFieldObject"/> to a <see cref="IRowObject"/> using supplied FieldNumber and FieldValue.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumber"></param>
/// <param name="fieldValue"></param>
/// <returns></returns>
public static IRowObject AddFieldObject(IRowObject rowObject, string fieldNumber, string fieldValue)
{
if (rowObject == null)
{
throw new System.ArgumentNullException("Parameter cannot be null.", "rowObject");
}
if (fieldNumber == null || fieldNumber == "")
{
throw new System.ArgumentNullException("The FieldNumber cannot be null or blank.");
}
return(AddFieldObject(rowObject, fieldNumber, fieldValue, false, false, false));
}
/// <summary>
/// Sets <see cref="FieldObject"/> in an <see cref="IRowObject"/> according to specified FieldAction.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldAction"></param>
/// <param name="fieldNumber"></param>
/// <returns></returns>
public static IRowObject SetFieldObject(IRowObject rowObject, string fieldAction, string fieldNumber)
{
if (rowObject == null)
{
throw new ArgumentNullException("Parameter cannot be null.", "rowObject");
}
List <string> fieldNumbers = new List <string> {
fieldNumber
};
return(SetFieldObjects(rowObject, fieldAction, fieldNumbers));
}
/// <summary>
/// Flags a <see cref="IRowObject"/> for deletion in specified <see cref="IOptionObject2"/>.
/// </summary>
/// <param name="optionObject"></param>
/// <param name="rowObject"></param>
/// <returns></returns>
public static IOptionObject2 DeleteRowObject(IOptionObject2 optionObject, IRowObject rowObject)
{
if (optionObject == null)
{
throw new ArgumentNullException("Parameter cannot be null.", "optionObject");
}
if (rowObject == null)
{
throw new ArgumentNullException("Parameter cannot be null.", "rowObject");
}
return(DeleteRowObject(optionObject.ToOptionObject2015(), rowObject).ToOptionObject2());
}
/// <summary>
/// Flags a <see cref="IRowObject"/> for deletion in specified <see cref="IFormObject"/>.
/// </summary>
/// <param name="formObject"></param>
/// <param name="rowObject"></param>
/// <returns></returns>
public static IFormObject DeleteRowObject(IFormObject formObject, IRowObject rowObject)
{
if (formObject == null)
{
throw new ArgumentNullException("Parameter cannot be null.", "formObject");
}
if (rowObject == null)
{
throw new ArgumentNullException("Parameter cannot be null.", "rowObject");
}
return(DeleteRowObject(formObject, rowObject.RowId));
}
/// <summary>
/// Flags a <see cref="IRowObject"/> for deletion in specified <see cref="IFormObject"/>.
/// </summary>
/// <param name="formObject"></param>
/// <param name="rowObject"></param>
/// <returns></returns>
public static IFormObject DeleteRowObject(IFormObject formObject, IRowObject rowObject)
{
if (formObject == null)
{
throw new ArgumentNullException(nameof(formObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
if (rowObject == null)
{
throw new ArgumentNullException(nameof(rowObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
return(DeleteRowObject(formObject, rowObject.RowId));
}
private static RowObject DisableAllFieldObjectsByRowObject(IRowObject rowObject, List <string> excludedFields)
{
for (int i = 0; i < rowObject.Fields.Count; i++)
{
if (!excludedFields.Contains(rowObject.Fields[i].FieldNumber))
{
rowObject.Fields[i].SetAsDisabled();
}
}
rowObject.RowAction = RowAction.Edit;
return((RowObject)rowObject);
}
/// <summary>
/// Sets <see cref="FieldObject"/> in an <see cref="IRowObject"/> according to specified FieldAction.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldAction"></param>
/// <param name="fieldNumber"></param>
/// <returns></returns>
public static IRowObject SetFieldObject(IRowObject rowObject, string fieldAction, string fieldNumber)
{
if (rowObject == null)
{
throw new ArgumentNullException(nameof(rowObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
List <string> fieldNumbers = new List <string> {
fieldNumber
};
return(SetFieldObjects(rowObject, fieldAction, fieldNumbers));
}
/// <summary>
/// Removes a <see cref="IFieldObject"/> from a <see cref="IRowObject"/>.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldObject"></param>
/// <returns></returns>
public static IRowObject RemoveFieldObject(IRowObject rowObject, IFieldObject fieldObject)
{
if (rowObject == null)
{
throw new ArgumentNullException(nameof(rowObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
if (fieldObject == null)
{
throw new ArgumentNullException(nameof(fieldObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
rowObject.Fields.Remove((FieldObject)fieldObject);
return((RowObject)rowObject);
}
/// <summary>
/// Removes a <see cref="IFieldObject"/> from a <see cref="IRowObject"/>.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldObject"></param>
/// <returns></returns>
public static IRowObject RemoveFieldObject(IRowObject rowObject, IFieldObject fieldObject)
{
if (rowObject == null)
{
throw new ArgumentNullException("Parameter cannot be null.", "rowObject");
}
if (fieldObject == null)
{
throw new ArgumentNullException("Parameter cannot be null.", "fieldObject");
}
rowObject.Fields.Remove((FieldObject)fieldObject);
return((RowObject)rowObject);
}
/// <summary>
/// Returns <see cref="IRowObject"/> as an HTML string with or without HTML headers.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="includeHtmlHeaders"></param>
/// <returns></returns>
public static string TransformToHtmlString(IRowObject rowObject, bool includeHtmlHeaders)
{
if (rowObject == null)
{
throw new ArgumentNullException(nameof(rowObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
StringBuilder sb = new StringBuilder();
sb.Append(GetHeader(rowObject.GetType().ToString(), includeHtmlHeaders));
sb.Append(GetHtmlForObject(rowObject, HtmlOutputType.Table));
sb.Append(AddFieldsTable(rowObject, 2));
sb.Append(GetFooter(includeHtmlHeaders));
return(sb.ToString());
}
/// <summary>
/// Adds a <see cref="IFieldObject"/> to a <see cref="IRowObject"/> using supplied FieldNumber and FieldValue and setting the Enabled, Locked, and Required values.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumber"></param>
/// <param name="fieldValue"></param>
/// <param name="enabled"></param>
/// <param name="locked"></param>
/// <param name="required"></param>
/// <returns></returns>
public static IRowObject AddFieldObject(IRowObject rowObject, string fieldNumber, string fieldValue, bool enabled, bool locked, bool required)
{
if (rowObject == null)
{
throw new System.ArgumentNullException(nameof(rowObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
if (string.IsNullOrEmpty(fieldNumber))
{
throw new System.ArgumentNullException(nameof(fieldNumber), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
FieldObject fieldObject = new FieldObject(fieldNumber, fieldValue, enabled, locked, required);
return(AddFieldObject(rowObject, fieldObject));
}
/// <summary>
/// Returns the FieldValue of a <see cref="IFieldObject"/> in a <see cref="IRowObject"/> by FieldNumber.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumber"></param>
/// <returns></returns>
public static string GetFieldValue(IRowObject rowObject, string fieldNumber)
{
if (rowObject == null)
{
throw new ArgumentNullException("Parameter cannot be null", "rowObject");
}
foreach (FieldObject field in rowObject.Fields)
{
if (field.FieldNumber == fieldNumber)
{
return(GetFieldValue(field));
}
}
throw new ArgumentException("FieldObject (" + fieldNumber + ") could not be found.");
}
/// <summary>
/// Returns whether the <see cref="IFieldObject"/> in the <see cref="IRowObject"/> is present by FieldNumber.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumber"></param>
/// <returns></returns>
public static bool IsFieldPresent(IRowObject rowObject, string fieldNumber)
{
if (rowObject == null)
throw new ArgumentNullException("Parameter cannot be null.", "rowObject");
if (rowObject.Fields == null)
throw new NullReferenceException("The RowObject does not contain any FieldObjects.");
if (fieldNumber == null || fieldNumber == "")
throw new ArgumentNullException("Parameter cannot be null or blank.", "fieldNumber");
foreach (FieldObject field in rowObject.Fields)
{
if (field.FieldNumber == fieldNumber)
return true;
}
return false;
}
/// <summary>
/// Adds a <see cref="IFieldObject"/> to a <see cref="IRowObject"/> using supplied FieldNumber and FieldValue and setting the Enabled, Locked, and Required values (e.g., Y or N).
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumber"></param>
/// <param name="fieldValue"></param>
/// <param name="enabledValue"></param>
/// <param name="lockedValue"></param>
/// <param name="requiredValue"></param>
/// <returns></returns>
public static IRowObject AddFieldObject(IRowObject rowObject, string fieldNumber, string fieldValue, string enabledValue, string lockedValue, string requiredValue)
{
if (rowObject == null)
{
throw new System.ArgumentNullException("Parameter cannot be null.", "rowObject");
}
if (fieldNumber == null || fieldNumber == "")
{
throw new System.ArgumentNullException("The FieldNumber cannot be null or blank.");
}
bool enabled = enabledValue == "1" ? true : false;
bool locked = lockedValue == "1" ? true : false;
bool required = requiredValue == "1" ? true : false;
return(AddFieldObject(rowObject, fieldNumber, fieldValue, enabled, locked, required));
}
private static string AddFieldsTable(IRowObject rowObject, int headingLevel)
{
StringBuilder sb = new StringBuilder();
if (rowObject != null && rowObject.Fields != null)
{
sb.Append("<h{}>Fields</h{}>").Replace("{}", headingLevel.ToString());
sb.Append("<table>");
sb.Append(GetHtmlForObject(rowObject.Fields.FirstOrDefault(), HtmlOutputType.TableHeaders));
foreach (FieldObject fieldObject in rowObject.Fields)
{
sb.Append(GetHtmlForObject(fieldObject, HtmlOutputType.TableRow));
}
sb.Append("</table>");
}
return(sb.ToString());
}
/// <summary>
/// Removes a <see cref="IFieldObject"/> from a <see cref="IRowObject"/> by FieldNumber.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumber"></param>
/// <returns></returns>
public static IRowObject RemoveFieldObject(IRowObject rowObject, string fieldNumber)
{
if (rowObject == null)
{
throw new ArgumentNullException(nameof(rowObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
if (string.IsNullOrEmpty(fieldNumber))
{
throw new ArgumentNullException(nameof(fieldNumber), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
FieldObject fieldObject = rowObject.Fields.Find(f => f.FieldNumber == fieldNumber);
if (fieldObject == null)
{
throw new NullReferenceException(ScriptLinkHelpers.GetLocalizedString("noFieldObjectsFoundByFieldNumber", CultureInfo.CurrentCulture) + fieldNumber);
}
return(RemoveFieldObject(rowObject, fieldObject));
}
/// <summary>
/// Removes a <see cref="IFieldObject"/> from a <see cref="IRowObject"/> by FieldNumber.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumber"></param>
/// <returns></returns>
public static IRowObject RemoveFieldObject(IRowObject rowObject, string fieldNumber)
{
if (rowObject == null)
{
throw new ArgumentNullException("Parameter cannot be null.", "rowObject");
}
if (fieldNumber == null || fieldNumber == "")
{
throw new ArgumentNullException("Parameter cannot be null or blank.", "fieldNumber");
}
FieldObject fieldObject = rowObject.Fields.Find(f => f.FieldNumber == fieldNumber);
if (fieldObject == null)
{
throw new NullReferenceException("The RowObject does not contain this FieldObject.");
}
return(RemoveFieldObject(rowObject, fieldObject));
}
/// <summary>
/// Returns the FieldValue of a <see cref="IFieldObject"/> in a <see cref="IRowObject"/> by FieldNumber.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumber"></param>
/// <returns></returns>
public static string GetFieldValue(IRowObject rowObject, string fieldNumber)
{
if (rowObject == null)
{
throw new ArgumentNullException(nameof(rowObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
if (string.IsNullOrEmpty(fieldNumber))
{
throw new ArgumentNullException(nameof(fieldNumber), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
foreach (FieldObject field in rowObject.Fields)
{
if (field.FieldNumber == fieldNumber)
{
return(GetFieldValue(field));
}
}
throw new ArgumentException(ScriptLinkHelpers.GetLocalizedString("noFieldObjectsFoundByFieldNumber", CultureInfo.CurrentCulture) + fieldNumber, nameof(fieldNumber));
}
/// <summary>
/// Adds a <see cref="IFieldObject"/> to a <see cref="IRowObject"/>.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldObject"></param>
/// <returns></returns>
public static IRowObject AddFieldObject(IRowObject rowObject, IFieldObject fieldObject)
{
if (rowObject == null)
{
throw new System.ArgumentNullException(nameof(rowObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
if (fieldObject == null)
{
throw new System.ArgumentNullException(nameof(fieldObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
if (rowObject.Fields.Contains((FieldObject)fieldObject))
{
throw new System.ArgumentException(ScriptLinkHelpers.GetLocalizedString("fieldObjectAlreadyExists", CultureInfo.CurrentCulture), nameof(fieldObject));
}
if (rowObject.Fields.Exists(f => f.FieldNumber == fieldObject.FieldNumber))
{
throw new System.ArgumentException(ScriptLinkHelpers.GetLocalizedString("fieldNumberAlreadyExists", CultureInfo.CurrentCulture));
}
rowObject.Fields.Add((FieldObject)fieldObject);
return(rowObject);
}
/// <summary>
/// Sets the FieldValue of a <see cref="FieldObject"/> in a <see cref="IRowObject"/> by FieldNumber.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumber"></param>
/// <param name="fieldValue"></param>
/// <returns></returns>
public static IRowObject SetFieldValue(IRowObject rowObject, string fieldNumber, string fieldValue)
{
if (rowObject == null)
{
throw new ArgumentNullException("Parameter cannot be null.", "rowObject");
}
if (fieldNumber == null || fieldNumber == "")
{
throw new ArgumentNullException("Parameter cannot be null or blank.", "fieldNumber");
}
for (int i = 0; i < rowObject.Fields.Count; i++)
{
if (rowObject.Fields[i].FieldNumber == fieldNumber)
{
rowObject.Fields[i] = (FieldObject)SetFieldValue(rowObject.Fields[i], fieldValue);
rowObject.RowAction = RowAction.Edit;
break;
}
}
return(rowObject);
}
/// <summary>
/// Sets the FieldValue of a <see cref="FieldObject"/> in a <see cref="IRowObject"/> by FieldNumber.
/// </summary>
/// <param name="rowObject"></param>
/// <param name="fieldNumber"></param>
/// <param name="fieldValue"></param>
/// <returns></returns>
public static IRowObject SetFieldValue(IRowObject rowObject, string fieldNumber, string fieldValue)
{
if (rowObject == null)
{
throw new ArgumentNullException(nameof(rowObject), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
if (string.IsNullOrEmpty(fieldNumber))
{
throw new ArgumentNullException(nameof(fieldNumber), ScriptLinkHelpers.GetLocalizedString("parameterCannotBeNull", CultureInfo.CurrentCulture));
}
for (int i = 0; i < rowObject.Fields.Count; i++)
{
if (rowObject.Fields[i].FieldNumber == fieldNumber)
{
rowObject.Fields[i].FieldValue = fieldValue;
rowObject.RowAction = RowAction.Edit;
break;
}
}
return(rowObject);
}
