#region MigraDoc - Creating Documents on the Fly
//
// Authors:
// Stefan Lange
// Klaus Potzesny
// David Stephensen
//
// Copyright (c) 2001-2017 empira Software GmbH, Cologne Area (Germany)
//
// http://www.pdfsharp.com
// http://www.migradoc.com
// http://sourceforge.net/projects/pdfsharp
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
#endregion
using System;
using MigraDoc.DocumentObjectModel.publics;
namespace MigraDoc.DocumentObjectModel.Fields
{
///
/// InfoField is used to reference one of the DocumentInfo fields in the document.
///
public class InfoField : DocumentObject
{
///
/// Initializes a new instance of the InfoField class.
///
public InfoField()
{ }
///
/// Initializes a new instance of the InfoField class with the specified parent.
///
public InfoField(DocumentObject parent) : base(parent) { }
#region Methods
///
/// Creates a deep copy of this object.
///
public new InfoField Clone()
{
return (InfoField)DeepCopy();
}
#endregion
#region Properties
///
/// Gets or sets the name of the information to be shown in the field.
///
public string Name
{
get { return _name.Value; }
set
{
if (IsValidName(value))
_name.Value = value;
else
throw new ArgumentException(DomSR.InvalidInfoFieldName(value));
}
}
[DV]
public NString _name = NString.NullValue;
#endregion
///
/// Determines whether the name is a valid InfoFieldType.
///
private bool IsValidName(string name)
{
// Check using a way that never throws an exception
#if SILVERLIGHT
if (validNames == null)
{
validNames = new string[4];
validNames[0] = "Title";
validNames[1] = "Author";
validNames[2] = "Keywords";
validNames[3] = "Subject";
}
#endif
foreach (string validName in validNames)
{
if (String.Compare(validName, name, StringComparison.OrdinalIgnoreCase) == 0)
return true;
}
return false;
}
#if SILVERLIGHT
private static string[] validNames;
#else
private static string[] validNames = Enum.GetNames(typeof(InfoFieldType));
#endif
///
/// Determines whether this instance is null (not set).
///
public override bool IsNull()
{
return false;
}
#region public
///
/// Converts InfoField into DDL.
///
public override void Serialize(Serializer serializer)
{
string str = "\\field(Info)";
if (Name == "")
throw new InvalidOperationException(DomSR.MissingObligatoryProperty("Name", "InfoField"));
str += "[Name = \"" + Name + "\"]";
serializer.Write(str);
}
///
/// Returns the meta object of this instance.
///
public override Meta Meta
{
get { return _meta ?? (_meta = new Meta(typeof(InfoField))); }
}
static Meta _meta;
#endregion
}
}