[This is preliminary documentation and is subject to change.]

Tries to cast the object specified in the basedOn parameter to a Boolean.

Namespace:  Firefly.Box
Assembly:  Firefly.Box (in Firefly.Box.dll) Version: 3.4.23.6473 (3.4.23.6473)

Syntax

C#
public static bool TryCast(
	Object basedOn,
	out Text result
)
Visual Basic (Declaration)
Public Shared Function TryCast ( _
	basedOn As Object, _
	<OutAttribute> ByRef result As Text _
) As Boolean
Visual C++
public:
static bool TryCast(
	Object^ basedOn, 
	[OutAttribute] Text^% result
)

Parameters

basedOn
Type: System..::.Object
The Object to cast to Boolean
result
Type: Firefly.Box..::.Text %
The Boolean field to update with the result

Return Value

The method returns true if successful, otherwise return false.

Examples

This example demonstrates the deferent aspects of casting
This example is in the form of Unit Tests. It references the NUnit framework. This framework can be downloaded from www.NUnit.org. For more information about unit testing visit: www.NUnit.org.
CopyC#
using System;
using System.Collections.Generic;
using System.Text;
using NUnit.Framework;
using Firefly.Box;
using Firefly.Box.Testing;


namespace TestFirefly.Box.Documentation
{
    [TestFixture]
    public class Cast
    {
        [Test]
        public void CastSuccess()
        {
            object o = 5;
            Number n = Number.Cast(o);
            n.ShouldBe(5);
        }
        [Test]
        [ExpectedException(typeof(InvalidCastException))]
        public void CastFail()
        {
            object o = "5";
            Number n = Number.Cast(o);
        }
        [Test]
        public void TryCastSuccess()
        {
            object o = 5;
            Number n;
            if (Number.TryCast(o, out n))
                n.ShouldBe(5);
            else
                Assert.Fail();
        }
        [Test]
        public void TryCastFail()
        {
            object o = "5";
            Number n;
            if (Number.TryCast(o, out n))
                Assert.Fail();
        }
    }
}

See Also