FDO .NET API Reference Feature Data Objects

mgDictionaryElement.h

Go to the documentation of this file.
00001 /*
00002 * Copyright (C) 2004-2006  Autodesk, Inc.
00003 * 
00004 * This library is free software; you can redistribute it and/or
00005 * modify it under the terms of version 2.1 of the GNU Lesser
00006 * General Public License as published by the Free Software Foundation.
00007 * 
00008 * This library is distributed in the hope that it will be useful,
00009 * but WITHOUT ANY WARRANTY; without even the implied warranty of
00010 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00011 * Lesser General Public License for more details.
00012 * 
00013 * You should have received a copy of the GNU Lesser General Public
00014 * License along with this library; if not, write to the Free Software
00015 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00016 *
00017 */
00018 
00019 #pragma once
00020 
00021 #include "Runtime\Disposable.h"
00022 
00023 class FdoDictionaryElement;
00024 
00025 BEGIN_NAMESPACE_OSGEO_COMMON
00026 
00027 /// \ingroup (OSGeoFDOCommon)
00028 /// \brief
00029 ///     DictionaryElement is an element in a DictionaryElementCollection. It consists of a
00030 ///     name-value pair.
00031 public __sealed __gc class DictionaryElement : public NAMESPACE_OSGEO_RUNTIME::Disposable
00032 {
00033 public:
00034     /// \brief
00035     ///     Constructs a new empty dictionary element
00036     /// 
00037     /// \param name 
00038     ///     The name of the element.
00039     /// 
00040     /// \param value 
00041     ///     The value of the element.
00042     /// 
00043     DictionaryElement(System::String* name, System::String* value);
00044 
00045     /// \brief
00046     ///     Constructs an elemnet based on an unmanaged instance of the object
00047     /// 
00048     /// \param unmanaged 
00049     ///     Input A Pointer to the unmanaged object.
00050     /// 
00051     /// \param autoDelete 
00052     ///     Input Indicates if the constructed object should be automatically deleted 
00053     ///     once it no longer referenced.
00054     /// 
00055     DictionaryElement(System::IntPtr unmanaged, System::Boolean autoDelete);
00056 
00057     /// \brief
00058     ///     Gets the name of this dictionary element
00059     /// 
00060     /// \return
00061     ///     Returns the dictionary element name
00062     /// 
00063     __property String* get_Name();
00064 
00065     /// \brief
00066     ///     Indicates whether the name of the DictionaryElement can be changed once
00067     ///     it has been created.
00068     /// 
00069     /// \return
00070     ///     Returns true if the DictionaryElement name can be changed; otherwise false.
00071     /// 
00072     __property System::Boolean get_CanSetName();
00073 
00074     /// \brief
00075     ///     Gets the value of this dictionary element.
00076     /// 
00077     /// \return
00078     ///     Returns the element value
00079     /// 
00080     __property System::String* get_Value();
00081 
00082     /// \brief
00083     ///     Sets the value of this dictionary element
00084     /// 
00085     /// \param value 
00086     ///     Input the value of the dictionary element
00087     /// 
00088     __property System::Void set_Value(String* value);
00089 
00090 /// \cond DOXYGEN-IGNORE
00091 protected:
00092     System::Void ReleaseUnmanagedObject();
00093 
00094 public private:
00095     inline FdoDictionaryElement* GetImpObj();
00096 /// \endcond
00097 };
00098 
00099 END_NAMESPACE_OSGEO_COMMON
00100 
00101 

Comments or suggestions? Send us feedback.