Galactix Home | Main Page | Class Hierarchy | Data Structures | Function List

IContact Interface Reference

The IContact object. More...

#include <tsssx.idl>

Inherits IDispatch.


Public Methods

HRESULT ToString ([out, retval] BSTR *pVal)
 Get a String representation of this object. More...

HRESULT Name ([out, retval] BSTR *pVal)
 Get the Name property of this object as a String. More...

HRESULT ID ([out, retval] long *pVal)
 Get the ID property of this object as a long. More...

HRESULT Comment ([out, retval] BSTR *pVal)
 Get the Comment property of this object as a String. More...

HRESULT Title ([out, retval] BSTR *pVal)
 Get the Title property of this object as a String. More...

HRESULT Street ([out, retval] BSTR *pVal)
 Get the Street property of this object as a String. More...

HRESULT City ([out, retval] BSTR *pVal)
 Get the City property of this object as a String. More...

HRESULT State ([out, retval] BSTR *pVal)
 Get the State property of this object as a String. More...

HRESULT Zip ([out, retval] BSTR *pVal)
 Get the Zip property of this object as a String. More...

HRESULT Country ([out, retval] BSTR *pVal)
 Get the Country property of this object as a String. More...

HRESULT EmailAddress ([out, retval] BSTR *pVal)
 Get the EmailAddress property of this object as a String. More...

HRESULT WebAddress ([out, retval] BSTR *pVal)
 Get the WebAddress property of this object as a String. More...

HRESULT DayPhone ([out, retval] BSTR *pVal)
 Get the DayPhone property of this object as a String. More...

HRESULT FAX ([out, retval] BSTR *pVal)
 Get the FAX property of this object as a String. More...

HRESULT HomePhone ([out, retval] BSTR *pVal)
 Get the HomePhone property of this object as a String. More...

HRESULT ImagePathname ([out, retval] BSTR *pVal)
 Get the ImagePathname property of this object as a String. More...

HRESULT LogoPathname ([out, retval] BSTR *pVal)
 Get the LogoPathname property of this object as a String. More...

HRESULT getNumOfAssociations ([out, retval] long *plNum)
 Get the number of leagues, teams, fields, or officials this contact is associated with. More...

HRESULT getAssociations ([out, retval] ITSSSObCollection **ppICollection)
 Returns a collection of ITSSSOb objects. More...

HRESULT MobilePhone ([out, retval] BSTR *pVal)
 Get the MobilePhone property of this object as a String. More...

Detailed Description

The IContact object.

The IContact object contains the name, address, phone, fax, email, web site, and other contact information for someone associated with a place or thing. The following objects have contacts: ILeague, ITeam, IVenue and IOfficial. You can get a list of all the contacts in the project by using the IProject's getContacts() method, or you can use the other object's getContacts() method to get the associated contacts. Do not create this object directly, instead use one of the above mentioned methods.

Program ID: TSSSX.Contact

Example: 

    Response.WriteLine("Here is a list of the contacts for the league '" + league.Name + "'");
    var eContacts = new Enumerator(league.getContacts());
    for (; !eContacts.atEnd(); eContacts.moveNext())
    {
        oContact = eContacts.item();

        // do something with the IContact object
        Response.WriteLine(oContact.Name);
    }

See also:
IProject, ILeague, ITeam, IVenue, IOfficial

Member Function Documentation

HRESULT IContact::City (  [out, retval] BSTR *    pVal ) 
 

Get the City property of this object as a String.

Example: 

    var sText = obj.City;

HRESULT IContact::Comment (  [out, retval] BSTR *    pVal ) 
 

Get the Comment property of this object as a String.

Example: 

    var sComment = obj.Comment;

HRESULT IContact::Country (  [out, retval] BSTR *    pVal ) 
 

Get the Country property of this object as a String.

Example: 

    var sText = obj.Country;

HRESULT IContact::DayPhone (  [out, retval] BSTR *    pVal ) 
 

Get the DayPhone property of this object as a String.

Example: 

    var sText = obj.DayPhone;

HRESULT IContact::EmailAddress (  [out, retval] BSTR *    pVal ) 
 

Get the EmailAddress property of this object as a String.

Example: 

    var sLink = "";
    if (obj.EmailAddress != "")
    {
        sLink = "<a href=\""mailto:" + obj.EmailAddress + "\">" + obj.EmailAddress + "</a>";
    }

HRESULT IContact::FAX (  [out, retval] BSTR *    pVal ) 
 

Get the FAX property of this object as a String.

Example: 

    var sText = obj.FAX;

HRESULT IContact::HomePhone (  [out, retval] BSTR *    pVal ) 
 

Get the HomePhone property of this object as a String.

Example: 

    var sText = obj.HomePhone;

HRESULT IContact::ID (  [out, retval] long *    pVal ) 
 

Get the ID property of this object as a long.

Example: 

    var iID = obj.ID;

HRESULT IContact::ImagePathname (  [out, retval] BSTR *    pVal ) 
 

Get the ImagePathname property of this object as a String.

If specified, the ImagePathname is the filename of the image associated with this object. This may not point to the actual file on the hard drive. For example, during the website generation all the images are copied to the ProjectName-Web\images folder. The example below would point to the website generated image file.

Example: 

    var sImg = "";
    if (obj.ImagePathname != "")
        sImg = "<img src=\"images/\" + obj.ImagePathname + "\">";

HRESULT IContact::LogoPathname (  [out, retval] BSTR *    pVal ) 
 

Get the LogoPathname property of this object as a String.

If specified, the LogoPathname is the filename of the logo image associated with this object. This may not point to the actual file on the hard drive. For example, during the website generation all the images are copied to the ProjectName-Web\images folder. The example below would point to the website generated image file.

Example: 

    var sImg = "";
    if (obj.ImagePathname != "")
        sImg = "<img src=\"images/\" + obj.LogoPathname + "\">";

HRESULT IContact::MobilePhone (  [out, retval] BSTR *    pVal ) 
 

Get the MobilePhone property of this object as a String.

Example: 

    var sText = obj.MobilePhone;

HRESULT IContact::Name (  [out, retval] BSTR *    pVal ) 
 

Get the Name property of this object as a String.

Example: 

    var sName = obj.Name;

HRESULT IContact::State (  [out, retval] BSTR *    pVal ) 
 

Get the State property of this object as a String.

Example: 

    var sText = obj.State;

HRESULT IContact::Street (  [out, retval] BSTR *    pVal ) 
 

Get the Street property of this object as a String.

Example: 

    var sText = obj.Street;

HRESULT IContact::Title (  [out, retval] BSTR *    pVal ) 
 

Get the Title property of this object as a String.

Example: 

    var sTitle = obj.Title;

HRESULT IContact::ToString (  [out, retval] BSTR *    pVal ) 
 

Get a String representation of this object.

Example: 

    var sImplicit = "The object '" + obj + "' ToString property was called implicitly.";
    var sDirect = "The object '" + obj.ToString + "' ToString property was called directly.";

HRESULT IContact::WebAddress (  [out, retval] BSTR *    pVal ) 
 

Get the WebAddress property of this object as a String.

Example: 

    var sLink = "";
    if (obj.WebAddress != "")
    {
        sLink = "<a href=\"" + obj.WebAddress + "\">" + obj.WebAddress + "</a>";
    }

HRESULT IContact::Zip (  [out, retval] BSTR *    pVal ) 
 

Get the Zip property of this object as a String.

Example: 

    var sText = obj.Zip;

HRESULT IContact::getAssociations (  [out, retval] ITSSSObCollection **    ppICollection ) 
 

Returns a collection of ITSSSOb objects.

Returns a ITSSSObCollection of ITSSSOb objects representing the ILeagues, ITeams, IVenues, and IOfficials this contact is associated with. You can use the IProject::getObjectType() method to determine what type of object is returned.

Example: 

    Response.Write("The contact " + contact.Name + " is associated with ");
    var eAssociates = new Enumerator(contact.getAssociations());
    for (; !eAssociates.atEnd(); eAssociates.moveNext())
    {
        var oObj = eAssociates.item();
        switch ( Project.getObjectType(oObj.ID) )
        {
            case 1: // ILeague
                Response.Write(" the league " + oObj.Name);
                break;
            case 2: // ITeam
                Response.Write(" the team " + oObj.Name);
                break;
            case 3: // IVenue
                Response.Write(" the field " + oObj.Name);
                break;
            case 4: // IOfficial
                Response.Write(" the official " + oObj.Name);
                break;
        }
    }

See also:
IProject, ILeague, ITeam, IVenue, IOfficial, ITSSSOb, ITSSSObCollection

HRESULT IContact::getNumOfAssociations (  [out, retval] long *    plNum ) 
 

Get the number of leagues, teams, fields, or officials this contact is associated with.

Gets the number of items this contact is associated with.

Example: 

    var iNum = contact.getNumOfAssociations();
    Response.Write(contact.Name + " is a contact for " + iNum + " items.");

Galactix Home | Main Page | Class Hierarchy | Data Structures | Function List

Copyright © 1996-2007, Galactix Software. All rights reserved.
Questions? Comments? Send email to support@galactix.com