Atom C# Reference Documentation

Atom

Represents an Atom document. The Atom API allows one to download, create and modify Atom documents.

Object Creation

Chilkat.Atom obj = new Chilkat.Atom();

Properties

public bool AbortCurrent {get; }

Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

public string DebugLogFilePath {get; set; }

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

public string LastErrorHtml {get; }

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

public string LastErrorText {get; }

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

Concept of LastErrorText

LastErrorText Standard Information

public string LastErrorXml {get; }

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

public bool LastMethodSuccess {get; set; }

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

public int NumEntries {get; }

Number of entries in the Atom document.

public bool VerboseLogging {get; set; }

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

public string Version {get; }

Version of the component/library, such as "9.5.0.63"

Methods

public int AddElement(string tag, string value);

Adds a new element to the Atom document. The tag is a string such as "title", "subtitle", "summary", etc. Returns the index of the element added, or -1 for failure.

public int AddElementDate(string tag, DateTime dateTime);

This method is deprecated. It will be removed in a future version.

Adds a new date-formatted element to the Atom document. The tag is a string such as "created", "modified", "issued", etc. Returns the index of the element added, or -1 for failure.

public int AddElementDateStr(string tag, string dateTimeStr);

Adds a new date-formatted element to the Atom document. The tag is a string such as "created", "modified", "issued", etc. The dateTimeStr should be an RFC822 formatted date/time string such as "Tue, 25 Sep 2012 12:25:32 -0500". Returns the index of the element added, or -1 for failure.

public int AddElementDt(string tag, CkDateTime dateTime);

Adds a new date-formatted element to the Atom document. The tag is a string such as "created", "modified", "issued", etc. Returns the index of the element added, or -1 for failure.

public int AddElementHtml(string tag, string htmlStr);

Adds a new HTML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

public int AddElementXHtml(string tag, string xmlStr);

Adds a new XHTML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

public int AddElementXml(string tag, string xmlStr);

Adds a new XML formatted element to the Atom document. Returns the index of the element added, or -1 for failure.

public void AddEntry(string xmlStr);

Adds an "entry" Atom XML document to the caller's Atom document.

public void AddLink(string rel, string href, string title, string typ);

Adds a link to the Atom document.

public void AddPerson(string tag, string name, string uri, string email);

Adds a person to the Atom document. The tag should be a string such as "author", "contributor", etc. If a piece of information is not known, an empty string or NULL value may be passed.

public void DeleteElement(string tag, int index);

Removes the Nth occurrence of a given element from the Atom document. Indexing begins at 0. For example, to remove the 2nd category, set tag = "category" and index = 1.

public void DeleteElementAttr(string tag, int index, string attrName);

Remove an attribute from an element.The index should be 0 unless there are multiple elements having the same tag, in which case it selects the Nth occurrence based on the index ( 0 = first occurrence ).

public void DeletePerson(string tag, int index);

Deletes a person from the Atom document. The tag is a string such as "author". The index should be 0 unless there are multiple elements having the same tag, in which case it selects the Nth occurrence based on the index. For example, DeletePerson("author",2) deletes the 3rd author.

public bool DownloadAtom(string url);

Download an Atom feed from the Internet and load it into the Atom object.

Returns true for success, false for failure.

public Task DownloadAtomAsync(string url);

Creates an asynchronous task to call the DownloadAtom method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.

Returns null on failure

(C#) How to Run an Asynchronous Task

(Mono C#) How to Run an Asynchronous Task

(.NET Core C#) How to Run an Asynchronous Task

(PowerShell) How to Run an Asynchronous Task

public string GetElement(string tag, int index);

Returns the content of the Nth element having a specified tag.

Returns null on failure

public string GetElementAttr(string tag, int index, string attrName);

Returns the value of an element's attribute. The element is selected by the tag name and the index (the Nth element having a specific tag) and the attribute is selected by name.

Returns null on failure

public int GetElementCount(string tag);

The number of elements having a specific tag.

public DateTime GetElementDate(string tag, int index);

This method is deprecated. It will be removed in a future version.

Returns an element's value as a date/time.

public string GetElementDateStr(string tag, int index);

Returns an element's value as a date/time in an RFC822 formatted string, such as such as "Tue, 25 Sep 2012 12:25:32 -0500".

Returns null on failure

public CkDateTime GetElementDt(string tag, int index);

Returns an element's value as a date/time object.

Returns null on failure

public Atom GetEntry(int index);

Returns the Nth entry as an Atom object. (Indexing begins at 0)

Returns null on failure

public string GetLinkHref(string relName);

Returns the href attribute of the link having a specified "rel" attribute (such as "service.feed", "alternate", etc.).

Returns null on failure

public string GetPersonInfo(string tag, int index, string tag2);

Returns a piece of information about a person. To get the 2nd author's name, call GetPersonInfo("author",1,"name").

Returns null on failure

public string GetTopAttr(string attrName);

Returns the value of an attribute on the top-level XML node. The tag of a top-level Atom XML node is typically "feed" or "entry", and it might have attributes such as "xmlns" and "xml:lang".

Returns null on failure

public bool HasElement(string tag);

True (1) if the element exists in the Atom document. Otherwise 0.

public bool LoadXml(string xmlStr);

Loads the Atom document from an XML string.

Returns true for success, false for failure.

public void NewEntry();

Initializes the Atom document to be a new "entry".

public void NewFeed();

Initializes the Atom document to be a new "feed".

public bool SaveLastError(string path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

public void SetElementAttr(string tag, int index, string attrName, string attrValue);

Adds or replaces an attribute on an element.

public void SetTopAttr(string attrName, string value);

Adds or replaces an attribute on the top-level XML node of the Atom document.

public string ToXmlString();

Serializes the Atom document to an XML string.

Returns null on failure

public void UpdateElement(string tag, int index, string value);

Replaces the content of an element.

public void UpdateElementDate(string tag, int index, DateTime dateTime);

This method is deprecated. It will be removed in a future version.

Replaces the content of a date-formatted element.

public void UpdateElementDateStr(string tag, int index, string dateTimeStr);

Replaces the content of a date-formatted element. The index should be an RFC822 formatted date/time string.

public void UpdateElementDt(string tag, int index, CkDateTime dateTime);

Replaces the content of a date-formatted element.

public void UpdateElementHtml(string tag, int index, string htmlStr);

Replaces the content of an HTML element.

public void UpdateElementXHtml(string tag, int index, string xmlStr);

Replaces the content of an XHTML element.

public void UpdateElementXml(string tag, int index, string xmlStr);

Replaces the content of an XML element.

public void UpdatePerson(string tag, int index, string name, string uri, string email);

Replaces the content of a person. To update the 3rd author, call UpdatePerson("author",2,"new name","new URL","new email"). If a piece of information is not known, pass an empty string or a NULL.

Events

public event AbortCheckEventHandler OnAbortCheck;

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

Chilkat .NET Event Implementation

Args are passed using Chilkat.AbortCheckEventArgs

Event callback implementation:

private void atom_OnAbortCheck(object sender, Chilkat.AbortCheckEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Atom atom = new Chilkat.Atom();
atom.OnAbortCheck += atom_OnAbortCheck;

Chilkat Mono/.NET Core/Xamarin Event Implementation

Event callback implementation:

private void handleAbortCheckEventHandler OnhandleAbortCheck
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Atom atom = new Chilkat.Atom();
// ...
Chilkat.Atom.AbortCheck abortCheck = new Chilkat.Atom.AbortCheck(handleAbortCheck);
atom.setAbortCheckCb(abortCheck);

public event BinaryDataEventHandler OnBinaryData;

Binary data provided by certain methods.

Chilkat .NET Event Implementation

Args are passed using Chilkat.BinaryDataEventArgs

Event callback implementation:

private void atom_OnBinaryData(object sender, Chilkat.BinaryDataEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Atom atom = new Chilkat.Atom();
atom.OnBinaryData += atom_OnBinaryData;

Chilkat Mono/.NET Core/Xamarin Event Implementation

Event callback implementation:

private void handleBinaryDataEventHandler OnhandleBinaryData
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Atom atom = new Chilkat.Atom();
// ...
Chilkat.Atom.BinaryData binaryData = new Chilkat.Atom.BinaryData(handleBinaryData);
atom.setBinaryDataCb(binaryData);

public event PercentDoneEventHandler OnPercentDone;

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to true will cause the method to abort and return a failed status (or whatever return value indicates failure).

Chilkat .NET Event Implementation

Args are passed using Chilkat.PercentDoneEventArgs

Event callback implementation:

private void atom_OnPercentDone(object sender, Chilkat.PercentDoneEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Atom atom = new Chilkat.Atom();
atom.OnPercentDone += atom_OnPercentDone;

Chilkat Mono/.NET Core/Xamarin Event Implementation

Event callback implementation:

private void handlePercentDoneEventHandler OnhandlePercentDone
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Atom atom = new Chilkat.Atom();
// ...
Chilkat.Atom.PercentDone percentDone = new Chilkat.Atom.PercentDone(handlePercentDone);
atom.setPercentDoneCb(percentDone);

public event ProgressInfoEventHandler OnProgressInfo;

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

Chilkat .NET Event Implementation

Args are passed using Chilkat.ProgressInfoEventArgs

Event callback implementation:

private void atom_OnProgressInfo(object sender, Chilkat.ProgressInfoEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Atom atom = new Chilkat.Atom();
atom.OnProgressInfo += atom_OnProgressInfo;

Chilkat Mono/.NET Core/Xamarin Event Implementation

Event callback implementation:

private void handleProgressInfoEventHandler OnhandleProgressInfo
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Atom atom = new Chilkat.Atom();
// ...
Chilkat.Atom.ProgressInfo progressInfo = new Chilkat.Atom.ProgressInfo(handleProgressInfo);
atom.setProgressInfoCb(progressInfo);

public event TaskCompletedEventHandler OnTaskCompleted;

Called in the background thread when an asynchronous task completes.

C# TaskCompleted Event Callback Example

Chilkat .NET Event Implementation

Args are passed using Chilkat.TaskCompletedEventArgs

Event callback implementation:

private void atom_OnTaskCompleted(object sender, Chilkat.TaskCompletedEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Atom atom = new Chilkat.Atom();
atom.OnTaskCompleted += atom_OnTaskCompleted;

Chilkat Mono/.NET Core/Xamarin Event Implementation

Event callback implementation:

private void handleTaskIdCompletedEventHandler OnhandleTaskIdCompleted
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Atom atom = new Chilkat.Atom();
// ...
Chilkat.Atom.TaskIdCompleted taskIdCompleted = new Chilkat.Atom.TaskIdCompleted(handleTaskIdCompleted);
atom.setTaskIdCompletedCb(taskIdCompleted);

public event TextDataEventHandler OnTextData;

Text data provided by certain methods.

Chilkat .NET Event Implementation

Args are passed using Chilkat.TextDataEventArgs

Event callback implementation:

private void atom_OnTextData(object sender, Chilkat.TextDataEventArgs args)
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Atom atom = new Chilkat.Atom();
atom.OnTextData += atom_OnTextData;

Chilkat Mono/.NET Core/Xamarin Event Implementation

Event callback implementation:

private void handleTextDataEventHandler OnhandleTextData
	{
	    // application code goes here.
	}

To add an event handler:

Chilkat.Atom atom = new Chilkat.Atom();
// ...
Chilkat.Atom.TextData textData = new Chilkat.Atom.TextData(handleTextData);
atom.setTextDataCb(textData);