CSF.Zpt.Tales.TemplateFile Class Reference

Wrapper type for a IZptDocument, expressing its state which is visible to TALES. More...

Inheritance diagram for CSF.Zpt.Tales.TemplateFile:

Collaboration diagram for CSF.Zpt.Tales.TemplateFile:

Public Member Functions
bool	HandleTalesPath (string pathFragment, out object result, Rendering.IRenderingContext currentContext)
	Gets an System.Object based upon a TALES path fragment. More...
	TemplateFile (IZptDocument document)
	Initializes a new instance of the CSF.Zpt.Tales.TemplateFile class. More...
Public Member Functions inherited from CSF.Zpt.Tales.ITalesPathHandler
bool	HandleTalesPath (string pathFragment, out object result, IRenderingContext currentContext)
	Gets an System.Object based upon a TALES path fragment. More...

Properties
IZptDocument	Document [get]
	Gets the document which is represented by the current instance. More...

Detailed Description

Wrapper type for a IZptDocument, expressing its state which is visible to TALES.

Constructor & Destructor Documentation

CSF.Zpt.Tales.TemplateFile.TemplateFile ( IZptDocument  document )

inline

Initializes a new instance of the CSF.Zpt.Tales.TemplateFile class.

Parameters

document

Document.

Member Function Documentation

bool CSF.Zpt.Tales.TemplateFile.HandleTalesPath ( string  pathFragment, out object  result, Rendering.IRenderingContext  currentContext  )

inline

Gets an System.Object based upon a TALES path fragment.

This method should return a System.Object which represents the traversal of a single-level TALES path fragment, from the current instance. The value of that fragment is passed via the name pathFragment .

The precise meaning of 'traversal' is left to the implementation, but typical semantics will see an object return an associated object from an object graph.

In this simple example, the Employee class may return data from a related Person object, without exposing the Person object directly. This might be because (as shown in this example), the API of that Person object is more complex than desired, and so TALES should see a simplified version.

public class Employee : ITalesPathHandler
{
  private Person _person;

  public bool HandleTalesPath(string pathFragment, out object result, RenderingContext currentContext)
  {
    switch(pathFragment)
    {
    case: "name";
      result = _person.Name;
      return true;
    case: "address";
      result = _person.Address.FullAddress;
      return true;
    case: "gender":
      result = _person.Gender.ToString();
      return true;
    default:
      result = null;
      return false;
    }
  }
}

Note that the return value does not need to be a primitive type. It may be a complex object, and the return value may also implement ITalesPathHandler if desired.

Returns

true if the path traversal was a success; false otherwise.

Parameters

pathFragment	The path fragment.
result	Exposes the result if the traversal was a success
currentContext	Gets the current rendering context.

Property Documentation

IZptDocument CSF.Zpt.Tales.TemplateFile.Document

get

Gets the document which is represented by the current instance.

The document.

---

The documentation for this class was generated from the following file:

• /home/craig/Projects/CSF.Zpt/CSF.Zpt.Abstractions/Tales/TemplateFile.cs